[Index]

Model: data/HcsEntitlementCatalogDAT

Catalogs

Entitlement catalogs limit the capabilities of entitlement profiles defined at hierarchy nodes at the same level or below where the entitlement catalog is defined.

Entitlement catalogs can be defined at the provider, reseller, or customer hierarchy level. Only one entitlement catalog may be defined at a given hierarchy node.

Procedure

See procedure below for clarity if required:

  1. Log in as provider administrator.

  2. Set the hierarchy path to the location where you want to create the entitlement catalog.

  3. Choose Entitlement > Catalogs.

  4. Click Add.

  5. Enter a name and optional description for the entitlement catalog.

  6. Select the services check boxes to include in the entitlement catalog. The available services are Voice, Voicemail, Presence, Extension Mobility, Single Number Reach, WebEx, CMR, and Webex Teams.

  7. Specify the maximum number of devices allowable for the entitlement catalog.

    The maximum number cannot exceed the total of the maximums for all the device groups included in the entitlement catalog.

  8. Click'+' next to Device Groups, and from the Device Group drop-down, choose a Device Group to include in the entitlement catalog.

  9. Specify the maximum number of devices allowed for the selected device group.

    The maximum number for any device group cannot exceed the maximum number of devices for the catalog.

  10. Click + to add more device groups to the entitlement catalog.

  11. Click Save.

The entitlement catalog is created. Entitlement profiles can now be created at or below the level of the entitlement catalog (see: Create an Entitlement Profile).

HcsEntitlementCatalogDAT

Model Details

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Voice
  • Field Name: voice
  • Type: Boolean
Voicemail
  • Field Name: voicemail
  • Type: Boolean
Presence
  • Field Name: presence
  • Type: Boolean
Single Number Reach
  • Field Name: snr
  • Type: Boolean
Extension Mobility
  • Field Name: extension_mobility
  • Type: Boolean
WebEx
  • Field Name: webex
  • Type: Boolean
Webex Teams
  • Field Name: spark
  • Type: Boolean
CMR
  • Field Name: cmr
  • Type: Boolean
Contact Center
  • Field Name: contact_center
  • Type: Boolean
Maximum Number of Devices Overall *
  • Field Name: num_devices
  • Type: Integer
Device Groups
  • Field Name: device_groups.[n]
  • Type: Array
Device Group *
  • Field Name: device_groups.[n].device_group
  • Type: String
  • Target: data/HcsDeviceGroupDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Maximum Number of Devices in Group *
  • Field Name: device_groups.[n].num_devices
  • Type: Integer
API reference for data/HcsEntitlementCatalogDAT