[Index]

Model: relation/HcsDpClassOfServiceREL

Class of Service (Site)

Full HTML Help

PROVIDER ONLY

Configure Class of Service for a Site

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.

  2. Select the relevant site.

    Note

    When adding CoS, ensure you select a valid site under the customer in the hierarchy. You can only add CoS at a site.

  3. Go to (default menus) Cisco Dial Plan Management > Site > Class of Service.

    Note

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

  4. Choose an option:

  5. Fill out a unique name for the CoS in the Class of Service Name field.

    Note

    Ensure the name is descriptive, using up to 50 alphanumeric characters, including spaces, period(s), hyphens (-), and underscore characters (_). You can also use macros in Automate to create a CoS name. See the Automate documentation for a list of possible macros.

    MMacros allow you to dynamically add site IDs, customer IDs, and other types of information to the CSS.

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

    The actual CSS that is sent to the CUCM (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.

  6. Optionally, at the Description field, fill out a description for the CoS.

  7. Choose route partition members to include in the CoS. To do this:

    1. Click the Plus icon (+) to add route partitions.
    2. From the drop-down, select a route partition member.
    3. Repeat this step until you have selected all the members you need for this CoS. If you want to remove any member from the CoS, click the Minus icon (-).
  8. Click Save to add the new CoS. The new CoS will display in the summary list view, from where you can update it or delete it in future, if required.

    When adding (including clone), updating, or deleting CoS, you can view transaction progress and details in the Transaction Logs.

Related Topics

Transaction Logging and Audit in the Core Feature Guide

Class of Service in the Core Feature Guide

Clone a Class of Service for a Site

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 CoS, ensure that you select a valid site under the customer in the hierarchy. Attempting to clone a CoS at any other node (at a customer or reseller for example), a system error reminds you that you must be at a site.

  2. Go to (default menus) Cisco Dial Plan Management > Site > Class of Service.

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

  4. Click Action > Clone.

  5. Fill out a unique name for the Class of Service in the Class of Service Name field.

    Note

    Ensure the name is descriptive, using up to 50 alphanumeric characters, including spaces, period(s), hyphens (-), and underscore characters (_).

  6. Optionally, fill out a description.

  7. Save the cloned CoS. This creates a new CoS.

    When adding (including clone), updating, or deleting CoS, you can view transaction progress and details in the Transaction Logs.

    Note

    Save the cloned CoS to the same site hierarchy as the original CoS. You can't save the clone to a different site or to a different hierarchy.

    The new CoS displays in the summary list view, from where it can be updated or deleted in future, if required.

Related Topics

Transaction Logging and Audit in the Core Feature Guide

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
Name *
  • Field Name: cos.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Description
  • Field Name: cos.description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
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%24l70ZCuIaBUcw5BvM%24yplxC1EHbrcnXRnpOFA8Boj6AuspvBBiKvbUc2ead5tu9LmV8Ih6V5h21UShJG/h6pls3i%2Bl97mcqFKb8C8jLhXo1/i0yCNxAzvSmRj39mwquEIMzFpmXZrft1iOUdHSxghLNSvCBzo78xKqdVaCpF5T41WCAxJqTiK/jk7AnMr5CmOZIaUmkUwEIQnuYOMLmIM5p2%2BT5x3M1vgW374x4ptEXwMP1%2BHUlLiPV6jRrrBfebhQTK01UJc8YN0JUwLCqMZ1YOsJ6c/3ifjRytNvmg4wlfKp8YcouANh4y/bXSYbGijHLvvozbIhK5Wyt5LyboykcrFmc/69HQq4XSXx8GSMChLFPRVidQ6cvERs4QTw3ngPcBriIGwuSDuGk3is%2BG9V2uTixlg2A2YUpuGobMULRE9vtxOhaAVRc8/B25QuL%2BA/hbj4ZE33%2BgUFyivm8v8W8SvuEAzWw7Mt2vLZswxfZHnlGNV%2BHCyFPgR8L/JDLXYF1gzmpOsHS8pfUDcmu6N4Aixy7KjgVUuRtLE%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
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"]