[Index]

Model: relation/HcsDpManageCustomerREL

Customer Dial Plan

Full HTML Help

PROVIDER ONLY

CISCO

Overview

For Cisco HCS dial plans, you must create a customer dial plan before you create the site dial plan. You can only add one dial plan per customer.

Cisco HCS dial plan schemas are configured such that the customer-level dial plan elements are not pushed to CUCM until the first site for the customer is deployed. Therefore, you will not see any dial plan elements provisioned on the CUCM until at least one site is deployed for the customer. See Create a Site Dial Plan.

Once you add a customer dial plan, the only change allowed is to enable CSS filtering.

Add a Cisco HCS Customer Dial Plan

This procedure adds a new Cisco HCS dial plan for a customer.

Note

The options you choose in this procedure define the type of Cisco HCS dial plan schema (Type 1 to 4) to be used.

To add a new dial plan for a customer:

  1. Log in to the VOSS Automate Admin portal as a Provider administrator or Customer administrator.

    Note

    For details around tasks that can be performed for each admin level, see Cisco Hosted Collaboration Solution Roles and Privileges.

  2. Go to (default menus) Cisco Dial Plan Management > Customer > Dial Plan to view existing dial plans in the list view.

  3. Click the Plus icon (+) to add a new customer dial plan; then, select the customer.

  4. On the Dial Plan / New Record page, choose one of the options in the table to configure the new dial plan, depending on whether a site-location code is required for the customer:

    Site-location code required?

    Select Site-Location Code (SLC) based dial plan, then:

    • Define whether to use an extension prefix. If yes, select Use extension prefix, then fill out the extension prefix.

    • Define whether to use an inter-site prefix for inter-site dialing. If yes, select Inter-Site Prefix required for inter-site dialing, then:

      • Fill out the inter-site prefix (ISP). The ISP can be just one digit.
      • Define whether the ISP is included in the directory number. If yes, define whether the ISP is included in the Voice Mail ID.

    • Define whether to enable CSS filtering. If yes, select Enable CSS filtering.

      When enabled, this setting filters the calling search spaces (CSS) available when configuring a subscriber, phone, or line, to Site level Class of Service (CoS) CSSs.

      By default, CSS filtering is disabled, which results in all available Cisco Unified Communications Manager (CUCM) CSSs being available when configuring a Subscriber, phone, or line.
    No site-location code required

    • Leave Site-Location Code (SLC) based dial plan unchecked.

    • Define whether to enable CSS filtering. If yes, select Enable CSS filtering.

      When enabled, this setting filters the calling search spaces (CSS) available when configuring a subscriber, phone, or line, to Site level Class of Service (CoS) CSSs.

      By default, CSS filtering is disabled, which results in all available Cisco Unified Communications Manager (CUCM) CSSs being available when configuring a Subscriber, phone, or line.

    Note

    The value in the read-only Customer ID field is a unique, auto-generated number allocated to the customer. Customer ID is particularly useful in shared deployments (where a cluster may be shared across multiple customers) to correlate specific elements to a customer. The customer ID displays in CUCM as a prefix to elements (for example Cu2Si7 identifies Customer 2, Site 7).

  5. Click Save to add the new customer dial plan.

    Note

    When adding lines (DNs) at the site level, you must define your DNs appropriately (that is, you are responsible for using ISP+SLC+EXT if you deploy a Type 2 dial plan). Otherwise your inter/intra site calls won't route. For details around defining directory numbers, see Number Range Management.

Add a Customer Dial Plan (Provider deployment)

This procedure adds a new Cisco HCS dial plan for a customer.

Note

To add a new dial plan for a customer:

  1. Log in to the VOSS Automate Admin portal as a Provider administrator or Customer administrator.

    Note

    For details around tasks that can be performed for each admin level, see Cisco Hosted Collaboration Solution Roles and Privileges.

  2. Go to (default menus) Dial Plan Management > Customer > Dial Plan. The Dial Plan list view displays existing dial plans.

  3. Click the Plus icon (+) to add a new customer dial plan; then, select the customer.

    Note

    You can only add one dial plan per customer.

  4. On the Dial Plan / New Record page, choose one of the options in the table to configure the new dial plan, depending on whether a site-location code is required for the customer:

    Site-location code required?

    Select Site-Location Code (SLC) based dial plan, then:

    • Define whether to use an extension prefix. If yes, select Use extension prefix, then fill out the extension prefix.

    • Define whether to use an inter-site prefix for inter-site dialing. If yes, select Inter-Site Prefix required for inter-site dialing, then:

      • Fill out the inter-site prefix (ISP). The ISP can be just one digit.
      • Define whether the ISP is included in the directory number. If yes, define whether the ISP is included in the Voice Mail ID.

    • Define whether to enable CSS filtering. If yes, select Enable CSS filtering.

      When enabled, this setting filters the calling search spaces (CSS) available when configuring a subscriber, phone, or line, to Site level Class of Service (CoS) CSSs.

      By default, CSS filtering is disabled, which results in all available Cisco Unified Communications Manager (CUCM) CSSs being available when configuring a Subscriber, phone, or line.
    No site-location code required

    • Leave Site-Location Code (SLC) based dial plan unchecked.

    • Define whether to enable CSS filtering. If yes, select Enable CSS filtering.

      When enabled, this setting filters the calling search spaces (CSS) available when configuring a subscriber, phone, or line, to Site level Class of Service (CoS) CSSs.

      By default, CSS filtering is disabled, which results in all available Cisco Unified Communications Manager (CUCM) CSSs being available when configuring a Subscriber, phone, or line.

    Note

    The value in the read-only Customer ID field is a unique, auto-generated number allocated to the customer. Customer ID is particularly useful in shared deployments (where a cluster may be shared across multiple customers) to correlate specific elements to a customer. The customer ID displays in CUCM as a prefix to elements (for example Cu2Si7 identifies Customer 2, Site 7).

  5. Click Save to add the new customer dial plan.

    Note

    • Cisco HCS dial plan schemas are configured such that the customer-level dial plan elements are not pushed to CUCM until the first site for the customer is deployed. Therefore, you will not see any dial plan elements provisioned on the CUCM until at least one site is deployed for the customer. See Create a Site Dial Plan.
    • When adding lines (DNs) at the site level, you must define your DNs appropriately (that is, you are responsible for using ISP+SLC+EXT if you deploy a Type 2 dial plan). Otherwise your inter/intra site calls won't route. For details around defining directory numbers, see Number Range Management.

Model Details: relation/HcsDpManageCustomerREL

Title Description Details
Customer Name * The name of the customer. Default: {{ macro.HcsDpCustomerName }}
  • Field Name: custName
  • Type: String
  • Target: /api/data/BaseCustomerDAT/choices/?field=CustomerName&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24pwFLV3P8yesH8Njv%24Kyc7aDxhLNXFIMcP4lq4XMRIZhMmqZ98ARfbubSZLuaRhtXzo7d3Gtci536LjE9wkdOweOOfbO2q9fbB7du%2Bm2yllYPiKAHxCY4oQLG1oDXI%2BkVtgcDZKS1u4ZkmNfA/KPAOH%2B7pIn7SmbXCvrHuTKaTAvpfA0Koagw/TcTdZX6TobqvgFbpGUaFwYrnVqY/iiqHbIdpS9LOcT%2B3Tn%2Bj3BDi4ftz8PTM7Hfhj0a9kaafCM5vf12ItmGWjxIdwp5Qd4GhFga6X6VGAOjDaPDZBkLQbSbION06nzgNn8yDOF6mj/AuKm3IxJQXlhPie85KKEG0h1Sb7jeYRMJBSnpV6yhVjcgfZ9nolL4mrlIM1TdAClZ93/UHNwqAJ0kq1hpv0PyIWs/vHFOdW1UsEMSt3pg%3D%24%3D%3D
  • Target attr: CustomerName
  • Target Model Type: data/BaseCustomerDAT
  • Default: {{ macro.HcsDpCustomerName }}
  • MaxLength: 1024
  • Format: uri
  • Choices: []
External breakout number * Default external breakout number for this customer. Default: 9
  • Field Name: ext
  • Type: String
  • Default: 9
  • MaxLength: 1
  • Pattern: ^[0-9]*$
Site-Location Code (SLC) Based Dial Plan * Indicates whether or not Site Location Code is required for this customer. Default: false
  • Field Name: slcBased
  • Type: Boolean
  • Default: false
Enable CSS filtering * Indicates enabling or disabling the CSS filtering in the Day 2 templates. Default: false
  • Field Name: isCSSEnable
  • Type: Boolean
  • Default: false
Inter-Site Prefix (ISP) Required Indicates whether or not ISP is required for inter-site dialing. Default: false
  • Field Name: ispReq
  • Type: Boolean
  • Default: false
Inter-Site Prefix Inter-site prefix if ISP required for inter-site dialing.
  • Field Name: isp
  • Type: String
  • MaxLength: 1
  • Pattern: ^$|^[0-9]+$
ISP included in SLC If ISP is required, indicates whether ISP is included in SLC. Default: false
  • Field Name: ispInSlc
  • Type: Boolean
  • Default: false
ISP included in Voice Mail ID If ISP is required, indicates whether ISP is included in the VMID. Default: false
  • Field Name: ispInVMID
  • Type: Boolean
  • Default: false
Use extension prefix? If selected, an extension prefix can be specified which can be used on sites for this customer. Default: false
  • Field Name: extPrefixInUse
  • Type: Boolean
  • Default: false
Extension prefix Specify an optional extension prefix for this customer. Each site can select whether this extension prefix will be required.
  • Field Name: extPrefix
  • Type: String
  • MaxLength: 1
  • Pattern: ^$|^[0-9#*]+$
Dial Plan Type * This is an internal field to store the DP type. Default: Unknown
  • Field Name: dpType
  • Type: String
  • Default: Unknown
  • MaxLength: 1024
Customer ID * Unique ID for this customer. Default: {{ macro.HcsDpCustomerId }}
  • Field Name: customerId
  • Type: String
  • Default: {{ macro.HcsDpCustomerId }}
  • MaxLength: 1024
Debug Info This is an internal field to store debug info. Default: ** Bogus DP customer **
  • Field Name: debug
  • Type: String
  • Default: ** Bogus DP customer **
  • MaxLength: 1024
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024