[Index]

Model: relation/DP_REL

Dial Plan Models

Overview

From the Dial Plan Models menu, a sub-menu and base model called Dial Plan Model is available to define the dial plan and to enter a name and type to group its elements.

The Dial Plan Type drop-down is used to tag it with its hierarchy, so that available dial plans to push or remove are filtered when using the Dial Plan Maintenance menu:

Note

If no Dial Plan Type tag is added to a dial plan, a new "in-progress" or "staging" dial plan can be created that will not show up to be pushed or removed on the Dial Plan Maintenance menu.

A description and notes for the Dial Plan Model definition can be added on the input form.

Dial Plan Model Elements

The remaining list of menus manage elements of dial plans created with the feature. Individual elements such as Route Patterns, SIP Trunks, and Translation Patterns each have a menu item from which it can be associated with a Dial Plan Model and managed.

The feature provides menu items or input fields to extend schema based dial plan management functionality. When a dial plan created with the feature is pushed from the Dial Plan Maintenance menu, the transaction log can be inspected to see the extended functionality:

When managing these dial plan elements, the installed named macros can be used to refer to data added from the Dial Plan Input Data menu.

The list view from each of these menus shows the Dial Plan Name - as defined from the Dial Plan Model menu - to which the element belongs. The feature structures the elements as instances of distinct data models.

There is an additional flexibility in the Route Patterns and Translation Patterns dial plan model elements so that a Local Dialing check box can be selected here if required when using a simpler or flat dial plan.

Dial Plan elements, such as Calling Search Space, can be cloned and edited to easily add another element to the dial plan by defining an "add-on" dial plan model, associating the cloned CSS element with it and pushing it to the required Call Manager cluster using the Dial Plan Maintenance menu. In this way the dial plan can be then be updated - functionality that is not possible in a schema based approach.

Additional workflows in the feature allow for values (for example MRGL) to be added from for example the Device Pools - Regions - Locations -SRST element input form, since the workflow will push to the these to the Call Manager cluster only after the prerequisite values become available. Inspect the transaction log to see the required sequence of data carried out with these workflows.

Device Pools - Regions - Locations - SRST

The Device Pool, Region, Location and SRST Reference dial plan model have been combined into one coherent data model for ease of entry into a call manager since the elements are often related.

Time Period Model

This allows the administrator to define an unlimited number of time periods.

Time Period fields:

Time Schedule Model

This allows the administrator to define an unlimited number of time schedules.

Time Schedule fields:

Transcoder Model

The transcoder dial plan model allows the administrator to define an unlimited number of transcoders.

Transcoder fields:

Conference Bridge Model

The Conference Bridge dial plan model allows the administrator to define an unlimited number of Conference Bridges.

Conference Bridge fields:

Media Resource Group Model

The Media Resource Group dial plan model allows the administrator to define an unlimited number of Media Resource Groups.

Media Resource Group fields:

Media Resource Group List Model

The Media Resource Group List dial plan model allows the administrator to define an unlimited number of Media Resource Group Lists.

Media Resource Group List fields:

Route List Model

The Route List dial plan model allows the administrator to define an unlimited number of Route Lists.

Route List fields:

Route Group Model

The Route Group dial plan model allows the administrator to define an unlimited number of Route Groups.

Route Group fields:

SIP Trunk Model

The SIP Trunk dial plan model allows the administrator to define an unlimited number of SIP Trunks.

SIP Trunk fields:

Partition Model

The Partition dial plan model allows the administrator to define an unlimited number of Partitions.

Partition fields:

Calling Search Space Model

The Calling Search Space (CSS) dial plan model allows the administrator to define an unlimited number of CSS.

CSS fields:

Route Pattern Model

The Route Pattern dial plan model allows the administrator to define an unlimited number of Route Patterns. "Local Dialing" flag will be covered in a following section.

Route Pattern fields:

Note that more discard instructions may be added at market demand.

Translation Pattern Model

The Translation Pattern dial plan model allows the administrator to define an unlimited number of Translation Patterns. "Local Dialing" flag will be covered in the following section.

Translation Pattern fields:

Route Pattern and Translation Pattern 'Local'

The Translation/Route Pattern local designation in dial plan model allows the administrator to define patterns as local or looping patterns from the Site/Customer dial plan input sheet. The dial plan input sheets allow for creating a list of local area code/exchange that can be referenced via macro values to create site or customer level unique patterns.

CTI Route Points

The CTI Route Point dial plan model allows the administrator to define an unlimited number of CTI Route points with an associated line.

CTI Route Point Device fields:

CTI Route Point Line Fields:

Called Party Transformation Model

The Called Party Transformation dial plan model allows the administrator to define an unlimited number of Called Party Transformations.

Called Party Transformation fields:

Note that more discard instructions may be added at market demand.

Calling Party Transformation Model

The Calling Party Transformation dial plan model allows the administrator to define an unlimited number of Calling Party Transformations.

Calling Party Transformation fields:

Note that more discard instructions may be added at market demand.

SIP Route Pattern Model

The SIP Route Pattern dial plan model allows the administrator to define an unlimited number of SIP Route Patterns.

SIP Route Pattern fields:

Relation to view all dial plan elements with the same Dial Plan name.

Model Details: relation/DP_REL

Title Description Details
Dial Plan Group Assigned by FDP
  • Field Name: Dial Plan
  • Type: Object
Dial Plan Name Dial Plan Name
  • Field Name: Dial Plan.dpName
  • Type: String
Description Dial Plan Description
  • Field Name: Dial Plan.description
  • Type: String
Notes Dial Plan Notes
  • Field Name: Dial Plan.notes
  • Type: String
Dial Plan Type
  • Field Name: Dial Plan.dpType
  • Type: String
  • Choices: ["Multi-tenant / Shared Architecture", "Global", "Site"]
Device Pool - Region - Location - SRST Group Assigned by FDP
  • Field Name: Device Pool - Region - Location - SRST
  • Type: Object
Dp-Reg-Loc
  • Field Name: DP-Reg-Loc.[n]
  • Type: Array
Call Manager Group Call Manager Group
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolCucmGroup
  • Type: String
Device Pool Name Device Pool Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolName
  • Type: String
Region Region Default: Default
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolRegion
  • Type: String
  • Default: Default
Location Location Default: Hub_None
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolLocation
  • Type: String
  • Default: Hub_None
Date/Time Group Date/Time Group
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolDateTime
  • Type: String
Add Custom Region Default: False
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionCustom
  • Type: Boolean
  • Default: False
Links - Bandwidth Between and Adjacent Locations Between Location
  • Field Name: locationBetween.[n]
  • Type: Array
Immersive Bandwidth Immersive Bandwidth Default: None
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationBetween.[n].betweenImmersiveBW
  • Type: String
  • Default: None
  • Choices: ["None", "Unlimited"]
Location Name Location Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationBetween.[n].betweenLocationName
  • Type: String
Video Bandwidth (kbps) Video Bandwidth (kbps) Default: None
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationBetween.[n].betweenVideoBW
  • Type: String
  • Default: None
  • Choices: ["None", "Unlimited"]
Audio Bandwidth Audio Bandwidth Default: Unlimited
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationBetween.[n].betweenAudioBW
  • Type: String
  • Default: Unlimited
  • Choices: ["Unlimited"]
Weight Weight Default: 50
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationBetween.[n].betweenWeight
  • Type: String
  • Default: 50
Related Region Related Region
  • Field Name: regionRelated.[n]
  • Type: Array
Related Region Name Related Region Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedRegionName
  • Type: String
Audio Codec Preference List Codec Preference Default: Use System Default
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedCodec
  • Type: String
  • Default: Use System Default
  • Choices: ["Use System Default", "Factory Default lossy", "Factory Default low loss"]
Maximum Audio Bit Rate Audio Bandwidth Default: 64 kbps (G.711)
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedAudioBW
  • Type: String
  • Default: 64 kbps (G.711)
  • Choices: ["Use System Default", "7 kbps (GSM-HR, G.723.1)", "8 kbps (G.729)", "13 kbps (GSM-FR, AMR)", "16 kbps (iLBC, G.728)", "24 kbps (AMR-WB)", "32 kbps (iSAC, G.722.1)", "64 kbps (G.711)", "128 kbps (AAC-LD [LATM])", "256 kbps (L16, AAC-LD)"]
Maximum Session Bit Rate for Video Calls Video Bandwidth Default: 384
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedVideoBW
  • Type: String
  • Default: 384
  • Choices: ["Use System Default", "Not Allowed"]
Lossy Network Lossy Network Default: Use System Default
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedLossy
  • Type: String
  • Default: Use System Default
  • Choices: ["Keep Current Setting", "Use System Default", "Low Loss", "Lossy"]
Maximum Session Bit Rate for Immersive Video Calls Immersive Video Bandwidth Default: 2147483647
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionRelated.[n].relatedVideoBWImmersive
  • Type: String
  • Default: 2147483647
  • Choices: ["Use System Default", "Not Allowed"]
Region Name Region Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].regionName
  • Type: String
Add Custom Location Add Custom Location Default: False
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationCustom
  • Type: Boolean
  • Default: False
Location Name Location Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationName
  • Type: String
Within Audio Bandwidth Within Audio Bandwidth Default: 0
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationWithinAudio
  • Type: String
  • Default: 0
Within Immersive Kbits Within Immersive Kbits Default: 0
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationWithinImmersive
  • Type: String
  • Default: 0
Location RSVP Settings Location RSVP Settings
  • Field Name: locationRelated.[n]
  • Type: Array
Location Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationRelated.[n].relatedLocationName
  • Type: String
RSVP Setting RSVP Setting Default: Use System Default
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationRelated.[n].rsvpSetting
  • Type: String
  • Default: Use System Default
  • Choices: ["Use System Default", "No Reservation", "Optional(Video Desired)", "Mandatory", "Mandatory(Video Desired)", "Allow Subscription", "Disallow Subscription"]
Within Video Bandwidth Within Video Bandwidth Default: 0
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].locationWithinVideo
  • Type: String
  • Default: 0
Add Custom SRST Reference Add Custom SRST Reference
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstCustom
  • Type: Boolean
Name Name of new SRST Reference.
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstName
  • Type: String
SRST Reference SRST Reference
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolSRST
  • Type: String
  • Choices: ["Disable", "Use Default Gateway"]
Port SRST Port. Default: 2000
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstPort
  • Type: String
  • Default: 2000
  • Pattern: ^[0-9]*|$
IP Address SRST Gateway IP Address.
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstIpAddress
  • Type: String
  • Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}|$
SIP Network/IP Address SRST SIP Network IP Address.
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstSipIpAddress
  • Type: String
  • Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}|$
Is SRST Secure? Is SRST Secure?
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstSecure
  • Type: Boolean
SIP Port SRST SIP Port. Default: 5060
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].srstSipPort
  • Type: String
  • Default: 5060
  • Pattern: ^[0-9]*|$
Media Resource Group List MRGL
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolmrgl
  • Type: String
Physical Location Physical Location
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoolPhysLoc
  • Type: String
Standard Local Route Groups Standard Local Route Groups
  • Field Name: dpoollrg_ARRAY.[n]
  • Type: Array
LRG Name Local Route Group Name Default: Standard Local Route Group
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoollrg_ARRAY.[n].lrgName
  • Type: String
  • Default: Standard Local Route Group
Route Group Name Route Group Name
  • Field Name: Device Pool - Region - Location - SRST.DP-Reg-Loc.[n].dpoollrg_ARRAY.[n].rgName
  • Type: String
Time Periods Group Assigned by FDP
  • Field Name: Time Periods
  • Type: Object
Time Period
  • Field Name: TimePeriod.[n]
  • Type: Array
Time Period Name * The name for this time period.
  • Field Name: Time Periods.TimePeriod.[n].name
  • Type: String
Description A meaningful description for this time period.
  • Field Name: Time Periods.TimePeriod.[n].time_period_description
  • Type: String
Time of Day Start * Time of Day Start Default: No Office Hours
  • Field Name: Time Periods.TimePeriod.[n].tod_start
  • Type: Any
  • Default: No Office Hours
  • Choices: ["No Office Hours"]
Time of Day End * The end time for this period. Default: No Office Hours
  • Field Name: Time Periods.TimePeriod.[n].tod_end
  • Type: Any
  • Default: No Office Hours
  • Choices: ["No Office Hours"]
Start Day Optional start day for this period. Default: None
  • Field Name: Time Periods.TimePeriod.[n].tod_start_day
  • Type: String
  • Default: None
  • Choices: ["None"]
End Day Optional end day for this period. Default: None
  • Field Name: Time Periods.TimePeriod.[n].tod_end_day
  • Type: String
  • Default: None
  • Choices: ["None"]
Start Month Optional start month for this period. Default: None
  • Field Name: Time Periods.TimePeriod.[n].tod_start_month
  • Type: String
  • Default: None
  • Choices: ["None"]
Start Day of Month Optional start day of month for this period. Default: 0
  • Field Name: Time Periods.TimePeriod.[n].tod_start_day_of_month
  • Type: Integer
  • Default: 0
End Month Optional end month for this period. Default: None
  • Field Name: Time Periods.TimePeriod.[n].tod_end_month
  • Type: String
  • Default: None
  • Choices: ["None"]
End Day of Month Optional end day of month for this period. Default: 0
  • Field Name: Time Periods.TimePeriod.[n].tod_end_day_of_month
  • Type: Integer
  • Default: 0
Time Schedules Group Assigned by FDP
  • Field Name: Time Schedules
  • Type: Object
Time Schedule
  • Field Name: TimeSchedule.[n]
  • Type: Array
Time Schedule Name * The name for this time schedule.
  • Field Name: Time Schedules.TimeSchedule.[n].name
  • Type: String
Description A meaningful description for this time schedule.
  • Field Name: Time Schedules.TimeSchedule.[n].description
  • Type: String
Time Periods
  • Field Name: time_schedule_members.[n]
  • Type: Array
Time Period Name A time period that is part of this time schedule.
  • Field Name: Time Schedules.TimeSchedule.[n].time_schedule_members.[n].timePeriodName
  • Type: String
Media Resource Groups Group Assigned by FDP
  • Field Name: Media Resource Groups
  • Type: Object
Media Resource Group
  • Field Name: MediaResourceGroup.[n]
  • Type: Array
Media Resource Group Name Media Resource Group Name
  • Field Name: Media Resource Groups.MediaResourceGroup.[n].name
  • Type: String
Description Description
  • Field Name: Media Resource Groups.MediaResourceGroup.[n].description
  • Type: String
Devices for this Group Devices for this Group
  • Field Name: devicesArray.[n]
  • Type: Array
Media Resource Media Resource
  • Field Name: Media Resource Groups.MediaResourceGroup.[n].devicesArray.[n].mResource
  • Type: String
Media Resource Group Lists Group Assigned by FDP
  • Field Name: Media Resource Group Lists
  • Type: Object
Media Resource Group List
  • Field Name: MediaResourceGroupList.[n]
  • Type: Array
Media Resource Group List Name Media Resource Group List Name
  • Field Name: Media Resource Group Lists.MediaResourceGroupList.[n].name
  • Type: String
Media Resource Groups Media Resource Groups
  • Field Name: mrgArray.[n]
  • Type: Array
Media Resource Group Media Resource Group
  • Field Name: Media Resource Group Lists.MediaResourceGroupList.[n].mrgArray.[n].mrgs
  • Type: String
Media Termination Point Group Assigned by FDP
  • Field Name: Media Termination Point
  • Type: Object
Mtp
  • Field Name: MTP.[n]
  • Type: Array
Dial Plan Name Dial Plan Name
  • Field Name: Media Termination Point.MTP.[n].dpName
  • Type: String
MTP Name MTP Name
  • Field Name: Media Termination Point.MTP.[n].name
  • Type: String
MTP Description MTP Description
  • Field Name: Media Termination Point.MTP.[n].description
  • Type: String
MTP Device Pool MTP Device Pool
  • Field Name: Media Termination Point.MTP.[n].mtpDP
  • Type: String
Trusted Relay Point Trusted Relay Point Default: false
  • Field Name: Media Termination Point.MTP.[n].trust
  • Type: Boolean
  • Default: false
  • Choices: ["true", "false"]
SIP Trunks Group Assigned by FDP
  • Field Name: SIP Trunks
  • Type: Object
Sip Trunk
  • Field Name: SIPTrunk.[n]
  • Type: Array
SIP Trunk Name SIP Trunk Name
  • Field Name: SIP Trunks.SIPTrunk.[n].name
  • Type: String
Description Description
  • Field Name: SIP Trunks.SIPTrunk.[n].desc
  • Type: String
Device Pool Device Pool
  • Field Name: SIP Trunks.SIPTrunk.[n].devicePool
  • Type: String
Call Classification Call Classification Default: OffNet
  • Field Name: SIP Trunks.SIPTrunk.[n].callClass
  • Type: String
  • Default: OffNet
  • Choices: ["OnNet", "OffNet"]
Media Resource Group List Media Resource Group List
  • Field Name: SIP Trunks.SIPTrunk.[n].mrgl
  • Type: String
Location Location
  • Field Name: SIP Trunks.SIPTrunk.[n].location
  • Type: String
Run On All Active Unified CM Nodes Run On All Active Unified CM Nodes
  • Field Name: SIP Trunks.SIPTrunk.[n].runOnAllNodes
  • Type: Boolean
Inbound Call CSS Inbound Call CSS
  • Field Name: SIP Trunks.SIPTrunk.[n].inboundCSS
  • Type: String
SIP Information SIP Information
  • Field Name: sipArray.[n]
  • Type: Array
Destination Address Destination Address
  • Field Name: SIP Trunks.SIPTrunk.[n].sipArray.[n].destination
  • Type: String
Destination Address IPv6 Destination Address IPv6
  • Field Name: SIP Trunks.SIPTrunk.[n].sipArray.[n].destinationV6
  • Type: String
Destination Address is an SRV Destination Address is an SRV
  • Field Name: SIP Trunks.SIPTrunk.[n].sipArray.[n].destSRV
  • Type: Boolean
Destination Port Destination Port
  • Field Name: SIP Trunks.SIPTrunk.[n].sipArray.[n].port
  • Type: String
SIP Trunk Security Profile SIP Trunk Security Profile Default: Non Secure SIP Trunk Profile
  • Field Name: SIP Trunks.SIPTrunk.[n].stsp
  • Type: String
  • Default: Non Secure SIP Trunk Profile
SIP Profile SIP Profile Default: Standard SIP Profile
  • Field Name: SIP Trunks.SIPTrunk.[n].sipProf
  • Type: String
  • Default: Standard SIP Profile
Route Groups Group Assigned by FDP
  • Field Name: Route Groups
  • Type: Object
Route Group
  • Field Name: RouteGroup.[n]
  • Type: Array
Route Group Name Route Group Name
  • Field Name: Route Groups.RouteGroup.[n].name
  • Type: String
Distribution Algorithm Distribution Algorithm Default: Circular
  • Field Name: Route Groups.RouteGroup.[n].distalg
  • Type: String
  • Default: Circular
  • Choices: ["Top Down", "Circular"]
Route Group Devices Route Group Devices
  • Field Name: rgArray.[n]
  • Type: Array
Device
  • Field Name: Route Groups.RouteGroup.[n].rgArray.[n].device
  • Type: String
Route Lists Group Assigned by FDP
  • Field Name: Route Lists
  • Type: Object
Route List
  • Field Name: RouteList.[n]
  • Type: Array
Route List Name Route List Name
  • Field Name: Route Lists.RouteList.[n].name
  • Type: String
Route List Description Route List Description
  • Field Name: Route Lists.RouteList.[n].description
  • Type: String
Call Manager Group Name
  • Field Name: Route Lists.RouteList.[n].callManagerGroup
  • Type: String
Route List Enabled
  • Field Name: Route Lists.RouteList.[n].routeListEnabled
  • Type: Boolean
Members
  • Field Name: members.[n]
  • Type: Array
Route Group Name
  • Field Name: Route Lists.RouteList.[n].members.[n].routeGroupName
  • Type: String
Selection Order
  • Field Name: Route Lists.RouteList.[n].members.[n].selectionOrder
  • Type: String
Use Calling Party's External Phone Number Mask Default: Default
  • Field Name: Route Lists.RouteList.[n].members.[n].useCallingPartyExternalPhoneNumMask
  • Type: String
  • Default: Default
  • Choices: ["Default", "On", "Off"]
Calling Party Transform Mask
  • Field Name: Route Lists.RouteList.[n].members.[n].callingPartyTransformMask
  • Type: String
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: Route Lists.RouteList.[n].members.[n].callingPartyPrefixDigits
  • Type: String
Called Party Discard Digits Default: None
  • Field Name: Route Lists.RouteList.[n].members.[n].calledPartyDiscardDigits
  • Type: String
  • Default: None
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Called Party Transform Mask
  • Field Name: Route Lists.RouteList.[n].members.[n].calledPartyTransformMask
  • Type: String
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: Route Lists.RouteList.[n].members.[n].calledPartyPrefixDigits
  • Type: String
Run On Every Node
  • Field Name: Route Lists.RouteList.[n].runOnEveryNode
  • Type: Boolean
Partitions Group Assigned by FDP
  • Field Name: Partitions
  • Type: Object
Partition
  • Field Name: Partition.[n]
  • Type: Array
Partition Name Partition Name
  • Field Name: Partitions.Partition.[n].name
  • Type: String
Partition Time Schedule Partition Time Schedule
  • Field Name: Partitions.Partition.[n].timeSchedule
  • Type: String
Partition Description Partition Description
  • Field Name: Partitions.Partition.[n].description
  • Type: String
CSS's Group Assigned by FDP
  • Field Name: CSS's
  • Type: Object
Css
  • Field Name: CSS.[n]
  • Type: Array
CSS Name CSS Name
  • Field Name: CSS's.CSS.[n].name
  • Type: String
CSS Description CSS Description
  • Field Name: CSS's.CSS.[n].description
  • Type: String
Partition Usage Default: General
  • Field Name: CSS's.CSS.[n].usage
  • Type: String
  • Default: General
Partitions The array of default partitions associated with this calling search space.
  • Field Name: members.[n]
  • Type: Array
Route Partition Names * Route Partition Names
  • Field Name: CSS's.CSS.[n].members.[n].partition
  • Type: String
Partition Index
  • Field Name: CSS's.CSS.[n].members.[n].index
  • Type: String
  • Pattern: ^[0-9]*
Trans Patterns Group Assigned by FDP
  • Field Name: Trans Patterns
  • Type: Object
Trans Pattern
  • Field Name: TransPattern.[n]
  • Type: Array
Translation Pattern Translation Pattern
  • Field Name: Trans Patterns.TransPattern.[n].pattern
  • Type: String
Translation Pattern Description Translation Pattern Description
  • Field Name: Trans Patterns.TransPattern.[n].description
  • Type: String
Partition Partition
  • Field Name: Trans Patterns.TransPattern.[n].partition
  • Type: String
Css
  • Field Name: Trans Patterns.TransPattern.[n].css
  • Type: String
Route Option Default: Route this pattern
  • Field Name: Trans Patterns.TransPattern.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • Choices: ["Route this pattern", "Block this pattern"]
Release Clause If this is a blocking pattern, select the release clause when the call is blocked. Default: No Error
  • Field Name: Trans Patterns.TransPattern.[n].releaseClause
  • Type: String
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Provide Outside Dial Tone
  • Field Name: Trans Patterns.TransPattern.[n].provideOutsideDialTone
  • Type: Boolean
Called Party Discard Digits
  • Field Name: Trans Patterns.TransPattern.[n].calledPartyDiscardDigits
  • Type: String
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Do Not Wait For Interdigit Timeout On Subsequent Hops
  • Field Name: Trans Patterns.TransPattern.[n].noWaitInterdigitTimeoutSubseqHops
  • Type: Boolean
Route Next Hop By Calling Party Number
  • Field Name: Trans Patterns.TransPattern.[n].nextHopByCallingPtyNum
  • Type: Boolean
Use Calling Party's External Phone Number Mask
  • Field Name: Trans Patterns.TransPattern.[n].useCallingPartyExternalPhoneNumMask
  • Type: Boolean
Calling Party Transform Mask
  • Field Name: Trans Patterns.TransPattern.[n].callingPartyTransformMask
  • Type: String
Use Originator's Calling Search Space
  • Field Name: Trans Patterns.TransPattern.[n].useOrigCss
  • Type: Boolean
Called Party Transform Mask
  • Field Name: Trans Patterns.TransPattern.[n].calledPartyTransformMask
  • Type: String
Urgent Priority
  • Field Name: Trans Patterns.TransPattern.[n].urgentPriority
  • Type: Boolean
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: Trans Patterns.TransPattern.[n].calledPartyPrefixDigits
  • Type: String
Calling Line Presentation Bit Default: Default
  • Field Name: Trans Patterns.TransPattern.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: Trans Patterns.TransPattern.[n].callingPartyPrefixDigits
  • Type: String
Calling Name Presentation Bit Default: Default
  • Field Name: Trans Patterns.TransPattern.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: Trans Patterns.TransPattern.[n].connLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: Trans Patterns.TransPattern.[n].connNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Route Patterns Group Assigned by FDP
  • Field Name: Route Patterns
  • Type: Object
Route Patterns
  • Field Name: RoutePatterns.[n]
  • Type: Array
Route Pattern Route Pattern
  • Field Name: Route Patterns.RoutePatterns.[n].pattern
  • Type: String
Route Pattern Description Route Pattern Description
  • Field Name: Route Patterns.RoutePatterns.[n].description
  • Type: String
Route Partition Route Partition Default: Originating Device
  • Field Name: Route Patterns.RoutePatterns.[n].routePartition
  • Type: String
  • Default: Originating Device
Numbering Plan
  • Field Name: Route Patterns.RoutePatterns.[n].numPlan
  • Type: String
Route Filter Route Filter
  • Field Name: Route Patterns.RoutePatterns.[n].routeFilter
  • Type: String
Route List
  • Field Name: Route Patterns.RoutePatterns.[n].routeList
  • Type: String
Allow Device Override
  • Field Name: Route Patterns.RoutePatterns.[n].allowDeviceOverride
  • Type: Boolean
Route Option Default: Route this pattern
  • Field Name: Route Patterns.RoutePatterns.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • Choices: ["Route this pattern", "Block this pattern"]
Release Clause If this is a blocking pattern, select the release clause when the call is blocked. Default: No Error
  • Field Name: Route Patterns.RoutePatterns.[n].releaseClause
  • Type: String
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Call Classification OnNet or Offnet call Default: OffNet
  • Field Name: Route Patterns.RoutePatterns.[n].callClassification
  • Type: String
  • Default: OffNet
  • Choices: ["OffNet", "OnNet"]
Gateway Name
  • Field Name: Route Patterns.RoutePatterns.[n].gatewayName
  • Type: String
Provide Outside Dial Tone
  • Field Name: Route Patterns.RoutePatterns.[n].provideOutsideDialTone
  • Type: Boolean
Allow Overlap Sending
  • Field Name: Route Patterns.RoutePatterns.[n].allowOverlapSending
  • Type: Boolean
Urgent Priority
  • Field Name: Route Patterns.RoutePatterns.[n].urgentPriority
  • Type: Boolean
Authorization Level Default: 0
  • Field Name: Route Patterns.RoutePatterns.[n].authLevel
  • Type: String
  • Default: 0
Require Forced Authorization Code
  • Field Name: Route Patterns.RoutePatterns.[n].reqForcedAuthCode
  • Type: Boolean
Require Client Matter Code
  • Field Name: Route Patterns.RoutePatterns.[n].reqClientMatterCode
  • Type: Boolean
Use Calling Party's External Phone Number Mask Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].useCallingPartyExternalPhoneNumMask
  • Type: String
  • Default: Default
  • Choices: ["Default", "On", "Off"]
Calling Party Transform Mask
  • Field Name: Route Patterns.RoutePatterns.[n].callingPartyTransformMask
  • Type: String
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: Route Patterns.RoutePatterns.[n].callingPartyPrefixDigits
  • Type: String
Called Party Discard Digits Default: None
  • Field Name: Route Patterns.RoutePatterns.[n].calledPartyDiscardDigits
  • Type: String
  • Default: None
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Called Party Transform Mask
  • Field Name: Route Patterns.RoutePatterns.[n].calledPartyTransformMask
  • Type: String
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: Route Patterns.RoutePatterns.[n].calledPartyPrefixDigits
  • Type: String
Calling Line Presentation Bit Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].connLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].connNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
MLPP Precedence Default: Default
  • Field Name: Route Patterns.RoutePatterns.[n].patternPrecedence
  • Type: String
  • Default: Default
  • Choices: ["Default", "Executive Override", "Flash", "Flash Override", "Immediate", "Priority", "Routine"]
Calling Party Trans Patterns Group Assigned by FDP
  • Field Name: Calling Party Trans Patterns
  • Type: Object
Calling Party Transformation
  • Field Name: CallingPartyTransformation.[n]
  • Type: Array
Pattern * The pattern for this calling party transformation.
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].pattern
  • Type: String
Partition The route partition to which this calling party transformation belongs.
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].partition
  • Type: String
Description A meaningful description for this calling party transformation pattern.
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].description
  • Type: String
Use Calling Party's External Phone Number Mask Default: Default
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].usecallingpartyexternalphonenummask
  • Type: String
  • Default: Default
  • Choices: ["Default", "On", "Off"]
Calling Line ID Presentation * Default: Default
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].cglineIdpres
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Party Transform Mask
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].transformmask
  • Type: String
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].prefixdigits
  • Type: String
Calling Party Discard Digits
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].discarddigits
  • Type: String
  • Choices: ["PreDot"]
Calling Party Numbering Plan * Default: Cisco CallManager
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].cgptynumplan
  • Type: String
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Calling Party Number Type * Default: Cisco CallManager
  • Field Name: Calling Party Trans Patterns.CallingPartyTransformation.[n].cgptynumtype
  • Type: String
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Called Party Trans Patterns Group Assigned by FDP
  • Field Name: Called Party Trans Patterns
  • Type: Object
Called Party Transformation
  • Field Name: CalledPartyTransformation.[n]
  • Type: Array
Pattern * The pattern for this called party transformation.
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].pattern
  • Type: String
Description A meaningful description for this called party transformation pattern.
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].description
  • Type: String
Route Partition The route partition to which this calling party transformation
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].partition
  • Type: String
Discard Digits
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].discarddigits
  • Type: String
  • Choices: ["PreDot", "PreDot Trailing-#"]
Called Party Transformation Mask
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].transformmask
  • Type: String
Called Party Prefix Digits
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].prefixdigits
  • Type: String
Called Party Number Type Default: Cisco CallManager
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].numtype
  • Type: String
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Called Party Numbering Plan Default: Cisco CallManager
  • Field Name: Called Party Trans Patterns.CalledPartyTransformation.[n].numplan
  • Type: String
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
CTI Route Points Group Assigned by FDP
  • Field Name: CTI Route Points
  • Type: Object
Cti Route Point
  • Field Name: CTIRoutePoint.[n]
  • Type: Array
Device Name * The name for this CTI route point.
  • Field Name: CTI Route Points.CTIRoutePoint.[n].deviceName
  • Type: String
Description Meaningful description for this CTI route point.
  • Field Name: CTI Route Points.CTIRoutePoint.[n].description
  • Type: String
Device Pool *
  • Field Name: CTI Route Points.CTIRoutePoint.[n].devicePool
  • Type: String
Calling Search Space
  • Field Name: CTI Route Points.CTIRoutePoint.[n].css
  • Type: String
Location
  • Field Name: CTI Route Points.CTIRoutePoint.[n].location
  • Type: String
Use Trusted Relay Point * Default: Default
  • Field Name: CTI Route Points.CTIRoutePoint.[n].useTrustedRelayPoint
  • Type: String
  • Default: Default
  • Choices: ["Default", "On", "Off"]
Calling Party Transformation CSS
  • Field Name: CTI Route Points.CTIRoutePoint.[n].cgPtyTransCss
  • Type: String
Geolocation
  • Field Name: CTI Route Points.CTIRoutePoint.[n].geolocation
  • Type: String
Use Device Pool Calling Party Transformation CSS
  • Field Name: CTI Route Points.CTIRoutePoint.[n].useDevPoolCgPtyTransCss
  • Type: Boolean
SIP Route Patterns Group Assigned by FDP
  • Field Name: SIP Route Patterns
  • Type: Object
Sip Route Pattern
  • Field Name: SIPRoutePattern.[n]
  • Type: Array
Pattern * The SIP route pattern.
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].pattern
  • Type: String
Description A meaningful description for this SIP route pattern.
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].description
  • Type: String
Usage * The usage for this SIP route pattern. Default: Domain Routing
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].usage
  • Type: String
  • Default: Domain Routing
  • Choices: ["Domain Routing"]
Route Partition * The route partition to which this pattern belongs.
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].routePartitionName
  • Type: String
Route Option Default: Route this pattern
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • Choices: ["Route this pattern", "Block this pattern"]
Calling Party Transformation Mask
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].callingPartyTransformationMask
  • Type: String
Use Calling Party's External Phone Number Mask Default: Default
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].useCallingPartyExternalPhoneNumMask
  • Type: String
  • Default: Default
  • Choices: ["Default", "On", "Off"]
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].callingPartyPrefixDigits
  • Type: String
Calling Line Presentation Bit Default: Default
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].connLinePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].connNamePresBit
  • Type: String
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Sip Trunk/Route List Name *
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].sipTrunkName
  • Type: String
Dn or Pattern IPv6
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].dnOrPatternIpv6
  • Type: String
Route On User Part
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].routeOnUserPart
  • Type: Boolean
Use Caller CSS
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].useCallerCss
  • Type: Boolean
Domain Routing Css Name
  • Field Name: SIP Route Patterns.SIPRoutePattern.[n].domainRoutingCssName
  • Type: String
Transcoders Group Assigned by FDP
  • Field Name: Transcoders
  • Type: Object
Transcoder
  • Field Name: Transcoder.[n]
  • Type: Array
Transcoder Name Transcoder Name
  • Field Name: Transcoders.Transcoder.[n].name
  • Type: String
Description Description
  • Field Name: Transcoders.Transcoder.[n].description
  • Type: String
Transcoder Type Transcoder Type Default: Cisco IOS Media Termination Point
  • Field Name: Transcoders.Transcoder.[n].type
  • Type: String
  • Default: Cisco IOS Media Termination Point
  • Choices: ["Cisco IOS Media Termination Point", "Cisco IOS Enhanced Media Termination Point"]
Device Pool Device Pool
  • Field Name: Transcoders.Transcoder.[n].devicePool
  • Type: String
Use Trusted Relay Point Use Trusted Relay Point Default: Default
  • Field Name: Transcoders.Transcoder.[n].trp
  • Type: String
  • Default: Default
  • Choices: ["Default", "Off", "On"]
Conference Bridge Group Assigned by FDP
  • Field Name: Conference Bridge
  • Type: Object
Conf Bridge
  • Field Name: ConfBridge.[n]
  • Type: Array
Conference Bridge Name Conference Bridge Name
  • Field Name: Conference Bridge.ConfBridge.[n].name
  • Type: String
Description Description
  • Field Name: Conference Bridge.ConfBridge.[n].description
  • Type: String
Conference Bridge Type Conference Bridge Type Default: Cisco IOS Conference Bridge
  • Field Name: Conference Bridge.ConfBridge.[n].cbType
  • Type: String
  • Default: Cisco IOS Conference Bridge
  • Choices: ["Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge"]
Location Location
  • Field Name: Conference Bridge.ConfBridge.[n].location
  • Type: String
Device Pool Device Pool
  • Field Name: Conference Bridge.ConfBridge.[n].devicePool
  • Type: String
Use Trusted Relay Point Use Trusted Relay Point Default: Default
  • Field Name: Conference Bridge.ConfBridge.[n].trp
  • Type: String
  • Default: Default
  • Choices: ["Default", "Off", "On"]
Advertised Patterns Group Assigned by FDP
  • Field Name: Advertised Patterns
  • Type: Object
Advertised Patterns
  • Field Name: AdvertisedPatterns.[n]
  • Type: Array
Pattern Description Pattern Description
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].description
  • Type: String
Dial Plan Name Dial Plan Name
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].dpName
  • Type: String
Pattern Pattern
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].pattern
  • Type: String
Pattern Type Pattern Type Default: Enterprise Number
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].patternType
  • Type: String
  • Default: Enterprise Number
  • Choices: ["Enterprise Number", "+E.164 Number"]
PSTN Failover Prepend Digits PSTN Failover Prepend Digits Default: 0
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].pstnFailoverPrependDigits
  • Type: String
  • Default: 0
Pstn Fail Strip Pstn Fail Strip Default: 0
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].pstnFailStrip
  • Type: String
  • Default: 0
Hosted Route PSTN Rule Hosted Route PSTN Rule Default: No PSTN
  • Field Name: Advertised Patterns.AdvertisedPatterns.[n].pstnRule
  • Type: String
  • Default: No PSTN
  • Choices: ["No PSTN", "Specify", "Use pattern"]
Call Park Group Assigned by FDP
  • Field Name: Call Park
  • Type: Object
Call Park
  • Field Name: CallPark.[n]
  • Type: Array
Dial Plan Name Dial Plan Name
  • Field Name: Call Park.CallPark.[n].dpName
  • Type: String
Call Park Number/Range * Call Park Number/Range
  • Field Name: Call Park.CallPark.[n].callParkNumRange
  • Type: String
Cisco Unified Communications Manager * Cisco Unified Communications Manager
  • Field Name: Call Park.CallPark.[n].cucm
  • Type: String
Partition Partition
  • Field Name: Call Park.CallPark.[n].partition
  • Type: String
Call Park Description Call Park Description
  • Field Name: Call Park.CallPark.[n].description
  • Type: String
Physical Location Group Assigned by FDP
  • Field Name: Physical Location
  • Type: Object
Physical Location
  • Field Name: PhysicalLocation.[n]
  • Type: Array
Dial Plan Name dial plan name
  • Field Name: Physical Location.PhysicalLocation.[n].dpName
  • Type: String
Physical Location Name Physical Location Name
  • Field Name: Physical Location.PhysicalLocation.[n].plName
  • Type: String
Description Description
  • Field Name: Physical Location.PhysicalLocation.[n].description
  • Type: String