[Index]

Model: relation/HcsDpClassOfServiceREL

Class of Service

Full HTML Help

PROVIDER ONLY

Configure Class of Service

This procedure creates a new Calling Search Space (CSS) or edits an existing CSS that is tied to a site. The CSS can be used as a Class of Service (COS) for a device or line, or any of the other templates that rely on COS to filter different features.

  1. Log in as provider, reseller, or customer administrator.

    Warning:

    When adding Class of Service, ensure that you select a valid site under the customer in the hierarchy node breadcrumb at the top of the view. If you attempt to add a Class of Service at any other node in the hierarchy, you will receive an error indicating that you must be at a site.

  2. Choose Cisco Dial Plan Management > Site > Class of Service.

    Note:

    There is one default Internal Calling Line Identification Presentation (CLIP) Class of Service that appears in the list. The default COS is provisioned automatically based on the criteria you selected when you added the site.

  3. Choose an option:

  4. Enter a unique name for the Class of Service in the Class of Service Name field. Try to make the name as descriptive as possible using up to 50 alphanumeric characters, including spaces, period(s), hyphens (-), and underscore characters (_). You can also make use of macros that are available in the system to create a Class of Service name. For a list of possible macros, see "Macros and Site Defaults Macros" in the "Advanced Feature Guide". Macros allow you to dynamically add site IDs, customer IDs, and other types of information to the CSS.

    Example: Cu1-24HrsCLIP-PT-{{macro.HcsDpSiteName}}

    Note:

    The actual CSS that is sent to the Cisco Unified Communications Manager (based on the macros entered) is mirrored in the Actual Calling Search Space field. For example, the macro example above changes to Cu1-24HrsCLIP-PT-SiteABC.

  5. Add a description for the Class of Service in the Description field if desired.

  6. Choose route partition members to include in the Class of Service by performing the following:

    1. Click + to add route partitions.
    2. From the drop-down menu, select a route partition member.
    3. Repeat this step as required until you have selected all desired members for this Class of Service.

    Note: To remove a member from the Class of Service, click -.

  7. Click Save to add the Class of Service that you defined. The new Class of Service appears in the table of Classes of Service and it can be edited or deleted as required.

Clone a Class of Service

This procedure clones an existing Class of Service (CoS) to the same site hierarchy node, with a new name.

  1. Log in as provider, reseller, customer, or site administrator.

    Note:

    When cloning a Class of Service (CoS), ensure that you select a valid site under the customer in the hierarchy node breadcrumb at the top of the view. If you attempt to clone a Class of Service at any other node in the hierarchy, you will receive an error indicating that you must be at a site.

  2. Choose Cisco Dial Plan Management > Site > Class of Service.

  3. Click on the Class of Service to be cloned.

  4. Click Action > Clone.

  5. Enter a unique name for the Class of Service in the Class of Service Name field. Make the name as descriptive as possible using up to 50 alphanumeric characters, including spaces, period(s), hyphens (-), and underscore characters (_).

  6. (Optional) Add a description for the Class of Service in the Description field.

  7. Click Save to save the new Class of Service.

    Note:

    You must save the cloned CoS to the same site hierarchy node as the original CoS. You cannot save the cloned Class of Service to a different site, or to a different hierarchy node.

    The new Class of Service appears in the table of Classes of Service and it can be edited or deleted as required.

Configure Class of Service (provider deployment)

Use this procedure to create a new Calling Search Space (CSS) or edit an existing CSS that is tied to a site. The CSS can be used as a Class of Service (COS) for a device or line, or any of the other templates that rely on COS to filter different features.

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.

    Warning:

    When adding Class of Service, ensure that you select a valid site under the customer in the hierarchy node breadcrumb at the top of the view. If you attempt to add a Class of Service at any other node in the hierarchy, you will receive an error indicating that you must be at a site.

  2. Choose Dial Plan Management > Site > Class of Service.

    Note:

    There is one default Internal Calling Line Identification Presentation (CLIP) Class of Service that appears in the list. The default COS is provisioned automatically based on the criteria you selected when you added the site.

  3. Perform one of:

  4. Enter a unique name for the Class of Service in the Class of Service Name field. Try to make the name as descriptive as possible using up to 50 alphanumeric characters, including spaces, period(s), hyphens (-), and underscore characters (_). You can also make use of macros that are available in the system to create a Class of Service name. For a list of possible macros, see "Macros and Site Defaults Macros" in the "Advanced Feature Guide". Macros allow you to dynamically add site IDs, customer IDs, and other types of information to the CSS.

    Example: Cu1-24HrsCLIP-PT-{{macro.HcsDpSiteName}}

    Note:

    The actual CSS that is sent to the Cisco Unified Communications Manager (based on the macros entered) is mirrored in the Actual Calling Search Space field. For example, the macro example above changes to Cu1-24HrsCLIP-PT-SiteABC.

  5. Add a description for the Class of Service in the Description field if desired.

  6. Choose route partition members to include in the Class of Service by performing the following:

    1. Click + to add route partitions.
    2. From the drop-down menu, select a route partition member.
    3. Repeat this step as required until you have selected all desired members for this Class of Service.

    Note: To remove a member from the Class of Service, click -.

  7. Click Save to add the Class of Service that you defined. The new Class of Service appears in the table of Classes of Service and it can be edited or deleted as required.

Model Details: relation/HcsDpClassOfServiceREL

Title Description Details
Class of Service Name * The name for this class of service. You can either select from drop down or enter a custom value. If selected from the drop down, selected CSS will be included as COS
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description (Deprecated) Deprecated.
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Calling Search Space Name (Deprecated) Deprecated.
  • Field Name: cssName
  • Type: String
  • MaxLength: 1024
Device CSS Name (Deprecated) Deprecated.
  • Field Name: deviceCssName
  • Type: String
  • MaxLength: 1024
Members Deprecated.
  • Field Name: partitions.[n]
  • Type: Array
Cos
  • Field Name: cos
  • Type: Object
Description
  • Field Name: cos.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Partition Usage Default: General
  • Field Name: cos.partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Index
  • Field Name: cos.members.member.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: cos.members.member.[n].routePartitionName
  • Type: String
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24LaLEgC4PlVYdHtZh%241G3Q1QM5V472qS3nSsa9JU7Yk3RifjCYmkYiIztENVySLRa64lluv9PRnct5sHG2CgtpvIx%2B3L5ZTUnMUisQKENOABId9sAS7GEXWHNS0z41%2Bbt7knZ1GEKtEr/D9JEijptOwhSsropknDmUpe18pDay3oRSngojI1vzZOpekmf/UNAFDu6gNdOkvJchfFKwssRsBFB3LHkvDnElNK9CSq8Eyfu9fNkMunktoJA4auPnd3lD7BiAW%2B1OyCbaQNLTfrZQr9TWENsxP01zhuAqfm2zfGEhsQrT0FSXSLosi2SrjzyLvn%2BGT7JcxepB3mTe1u14cMMuphUcmb6BWKcOyahadfsAWouP/FDzBmtv5vH2uagzE54nr2PUSs%2BB43XMi5meLfZVNGRzfIIZMpGf%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Name *
  • Field Name: cos.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50