[Index]

Model: data/HcsDpDialPlanSchemaGroupDAT

Dial Plan Schema Group

Use this procedure to bundle a set of schemas to form a custom dial plan. You can clone one of default Type 1 to Type 4 schema groups to use as a starting point to create your own dial plan schema group.

  1. Log in to VOSS-4-UC as the Administrator, Provider, or Reseller.
  2. Select Dial Plan Management > Advanced Configuration > Dial Plan Schema Group.
  3. From the list of dial plan schema groups, choose the one to be cloned, by clicking on its box in the leftmost column.

Note

There may be duplicate dial plan schema groups in the list because some of the dial plan schema groups may have been auto-cloned to the Provider hierarchy node. For more information, see Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node.

  1. From the General tab, enter a new unique name for the cloned dial plan schema group in the Dial Plan Schema Group Name field.
  2. If desired, add a description of the new cloned dial plan schema group in the Description field.
  3. Modify or add site defaults, core schemas, feature schemas, country schemas, or custom workflows as required by clicking on the appropriate tab as follows:
    1. From the Site Defaults tab, modify site defaults. For more information on site defaults, refer to Modify Site Defaults.
    2. From the Core Schemas tab, modify the fields. Select a trigger event from the Dial Plan Schema Usage drop-down menu, then select the hierarchical level for the core schema in the Dial Plan Schema Scope drop-down menu. For a description of the trigger events, refer to Default Dial Plan Event Triggers. From the Dial Plan Schema Name drop-down menu, select the schema that will be triggered by the event. This drop-down list includes all default and created schemas from the Create Schemas procedure.
    3. From the Feature Schemas tab, modify the fields. Select a trigger event from the Dial Plan Schema Usage drop-down menu, then select the hierarchical level for the feature schema in the Dial Plan Schema Scope drop-down menu. For a description of the trigger events, refer to Default Dial Plan Event Triggers. From the Dial Plan Schema Name drop-down menu, select the feature schema that will be triggered by the event. This drop-down list includes all default and created feature schemas from the Create Schemas procedure.
    4. From the Country Schemas tab, modify the fields as required. For desired country schemas, select a trigger event from the Dial Plan Schema Usage drop-down menu, then select the country dial plan from the Country Name drop-down menu. Select the hierarchical level for the country schema in the Dial Plan Schema Scope drop-down menu. For a description of the trigger events, refer to Default Dial Plan Event Triggers. From the Dial Plan Schema Name drop-down menu, select the country-specific schema that will be triggered by the event. This drop-down list includes all default and created schemas from the Create Schemas procedure.
    5. From the Custom Workflows tab, modify event workflows. From the Dial Plan Event drop-down menu, select an event trigger for your workflow. Contact Advanced Services if you require an event trigger that is not in the list. For a description of the trigger events, refer to Default Dial Plan Event Triggers. From the Workflow drop-down menu, select the custom workflow to execute when the dial plan event is triggered.
  4. Click Save. The new dial plan schema group appears in the list of groups.

A group of related dial plan schemas for a particular deployment. Also includes other contextual information such as default site-specific info for Day 2 templates and hooks for custom dial plan related workflows.

Model Details

Title Description Details
Dial Plan Schema Group Name * Dial Plan Schema Group Name
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this dial plan schema group.
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Site Defaults
  • Field Name: siteDefaultsDoc
  • Type: Object
Default User Profile (for User Self Provisioning) Default User Profile (for User Self Provisioning) for a site
  • Field Name: siteDefaultsDoc.defaultUserProfile
  • Type: String
  • MaxLength: 1024
Default CUCM Service Profile Default CUCM Service Profile for a site
  • Field Name: siteDefaultsDoc.defaultCucmServiceProfile
  • Type: String
  • MaxLength: 1024
Default CUCM Region Default CUCM Region for a site
  • Field Name: siteDefaultsDoc.defaultCucmRegion
  • Type: String
  • MaxLength: 1024
Default Device Pool Default device pool for a site Default: Default
  • Field Name: siteDefaultsDoc.defaultDevicePool
  • Type: String
  • Default: Default
  • MaxLength: 1024
Default Location Default location for a site
  • Field Name: siteDefaultsDoc.defaultLocation
  • Type: String
  • MaxLength: 1024
Default Line Partition Default line partition for a site
  • Field Name: siteDefaultsDoc.defaultLinePartition
  • Type: String
  • MaxLength: 1024
Default Call Pickup Partition Default call pickup partition for a site
  • Field Name: siteDefaultsDoc.defaultCallPickupPartition
  • Type: String
  • MaxLength: 1024
Default Call Park Partition Default call park partition for a site
  • Field Name: siteDefaultsDoc.defaultCallParkPartition
  • Type: String
  • MaxLength: 1024
Default MeetMe Partition Default MeetMe partition for a site
  • Field Name: siteDefaultsDoc.defaultMeetMePartition
  • Type: String
  • MaxLength: 1024
Default PLAR CSS Default PLAR CSS for a site
  • Field Name: siteDefaultsDoc.defaultPlarCss
  • Type: String
  • MaxLength: 1024
Default Device CSS Default device CSS for a site
  • Field Name: siteDefaultsDoc.defaultDeviceCss
  • Type: String
  • MaxLength: 1024
Default Line CSS Default line CSS for a site
  • Field Name: siteDefaultsDoc.defaultLineCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward On Failure CSS Default CUCM line call forward on failure CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdOnFailureCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward On Failure Internal CSS Default CUCM line call forward on failure internal CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdOnFailureInternalCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward Not Registered CSS Default CUCM line call forward not registered CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdNotRegisteredCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward No Coverage CSS Default CUCM line call forward no coverage CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdNoCoverageCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward No Coverage Internal CSS Default CUCM line call forward no coverage internal CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdNoCoverageInternalCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward Secondary CSS Default CUCM line call forward secondary CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdSecondaryCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward Alternate Party CSS Default CUCM line call forward alternate party CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdAlternatePartyCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward Busy CSS Default CUCM line call forward busy CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdBusyCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward Busy Internal CSS Default CUCM line call forward busy internal CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdBusyInternalCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward No Answer CSS Default CUCM line call forward no answer CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdNoAnswerCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward No Answer Internal CSS Default CUCM line call forward no answer internal CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdNoAnswerInternalCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward All CSS Default CUCM line call forward all CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdAllCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Call Forward CSS Default CUCM line call forward CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineCallFwdCss
  • Type: String
  • MaxLength: 1024
Default CUCM Line Alternate Enterprise Partition Default CUCM line alternate enterprise partition for a site
  • Field Name: siteDefaultsDoc.defaultCucmAltEnterprisePt
  • Type: String
  • MaxLength: 1024
Default CUCM Device Profile Line E164 Mask Default CUCM device profile Line E164 mask for a site
  • Field Name: siteDefaultsDoc.defaultCucmDeviceProfileE164Mask
  • Type: String
  • MaxLength: 1024
Default CUCM Device Profile EMCC CSS Default CUCM device profile EMCC CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmDeviceProfileEmccCss
  • Type: String
  • MaxLength: 1024
Default CUCM User SUBSCRIBE CSS Default CUCM user SUBSCRIBE CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmUserSubscriberCss
  • Type: String
  • MaxLength: 1024
Default CUCM Phone SUBSCRIBE CSS Default CUCM phone SUBSCRIBE CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmPhoneSubscriberCss
  • Type: String
  • MaxLength: 1024
Default CUCM Phone Line E164 Mask Default CUCM phone line E164 mask for a site
  • Field Name: siteDefaultsDoc.defaultCucmPhoneLineE164Mask
  • Type: String
  • MaxLength: 1024
Default CUCM Line Alternate E164 Partition Default CUCM line alternate E164 Partition for a site
  • Field Name: siteDefaultsDoc.defaultCucmLineAlternateE164Pt
  • Type: String
  • MaxLength: 1024
Default CUCM Remote Destination Profile Rerouting CSS Default CUCM remote destination profile rerouting CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmRdpReroutingCss
  • Type: String
  • MaxLength: 1024
Default CUCM Remote Destination Profile Line E164 Mask Default CUCM remote destination profile line E164 mask for a site
  • Field Name: siteDefaultsDoc.defaultCucmRdpLineE164Mask
  • Type: String
  • MaxLength: 1024
Default CUCM Remote Destination Profile CSS Default CUCM remote destination profile CSS for a site
  • Field Name: siteDefaultsDoc.defaultCucmRdpCss
  • Type: String
  • MaxLength: 1024
Default CUCM Hunt Pilot Partition Default CUCM hunt pilot partition for a site
  • Field Name: siteDefaultsDoc.defaultCucmHuntPilotPt
  • Type: String
  • MaxLength: 1024
Default CUCM Group Default CUCM Group for a site
  • Field Name: siteDefaultsDoc.defaultCucmGroup
  • Type: String
  • MaxLength: 1024
Core Dial Plan Schemas The dial plan schemas that compose this group.
  • Field Name: members.[n]
  • Type: Array
Dial Plan Schema Usage * Select when the dial plan schema should be deployed.
  • Field Name: members.[n].usage
  • Type: String
  • Target: data/HcsDpDialPlanSchemaUsageDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Dial Plan Schema Scope * Select the scope at which this dial plan schema should be deployed.
  • Field Name: members.[n].scope
  • Type: String
  • MaxLength: 1024
  • Choices: ["Site", "Customer", "Reseller", "Provider"]
Dial Plan Schema Name * Select the dial plan schema to deploy.
  • Field Name: members.[n].dialPlanSchema
  • Type: String
  • Target: data/HcsDpDialPlanSchemaDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Feature Dial Plan Schemas The feature dial plan schemas that compose this group.
  • Field Name: featureMembers.[n]
  • Type: Array
Dial Plan Schema Usage * Select when the dial plan schema should be deployed.
  • Field Name: featureMembers.[n].usage
  • Type: String
  • Target: data/HcsDpDialPlanSchemaUsageDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Dial Plan Schema Scope * Select the scope at which this dial plan schema should be deployed.
  • Field Name: featureMembers.[n].scope
  • Type: String
  • MaxLength: 1024
  • Choices: ["Site", "Customer", "Reseller", "Provider"]
Dial Plan Schema Name * Select the dial plan schema to deploy.
  • Field Name: featureMembers.[n].dialPlanSchema
  • Type: String
  • Target: data/HcsDpDialPlanSchemaDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Country Dial Plan Schemas The country dial plan schemas that compose this group.
  • Field Name: countryMembers.[n]
  • Type: Array
Dial Plan Schema Usage * Select when the dial plan schema should be deployed.
  • Field Name: countryMembers.[n].usage
  • Type: String
  • Target: data/HcsDpDialPlanSchemaUsageDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Country Name * Select the country to associate to the dial plan schema.
  • Field Name: countryMembers.[n].country
  • Type: String
  • Target: data/Countries
  • Target attr: country_name
  • MaxLength: 1024
  • Format: uri
Dial Plan Schema Scope * Select the scope at which this dial plan schema should be deployed.
  • Field Name: countryMembers.[n].scope
  • Type: String
  • MaxLength: 1024
  • Choices: ["Site", "Customer", "Reseller", "Provider"]
Dial Plan Schema Name * Select the dial plan schema to deploy.
  • Field Name: countryMembers.[n].dialPlanSchema
  • Type: String
  • Target: data/HcsDpDialPlanSchemaDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Custom Workflow Registry Custom workflows can be executed for specific dial plan events.
  • Field Name: customWorkflows.[n]
  • Type: Array
Dial Plan Event * Select a dial plan event that will trigger the custom workflow.
  • Field Name: customWorkflows.[n].event
  • Type: String
  • Target: data/HcsDpDialPlanSchemaCustomWorkflowEventDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Workflow * The custom workflow to execute when the dial plan event is triggered.
  • Field Name: customWorkflows.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
API reference for data/HcsDpDialPlanSchemaGroupDAT