[Index]

Model: data/HcsEntitlementCatalogDAT

Catalogs

Full HTML Help

Entitlement catalogs are used in entitlement to limit the devices and services that entitlement profiles (those defined at the same hierarchy or below) may assign to users.

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.

Note

The animation shows the procedure for creating both an entitlement catalog and an entitlement profile. An entitlement catalog must exist at or above the hierarchy level at which you want to create the entitlement profile.

Pre-requisites:

To add an entitlement catalog:

  1. Log in as provider administrator.

  2. Choose the hierarchy where you want to create the entitlement catalog.

    Note

    You can only create one entitlement catalog at each hierarchy.

  3. Go to (default menus) Entitlement > Catalogs.

  4. Click Add.

  5. On the Catalogs page, complete the basic configuration for the new entitlement catalog:

    Note

    Restrictions defined for device groups, device counts, and services in a catalog at a particular hierarchy apply to entitlement profiles and catalogs at that hierarchy, and below. For example, restrictions in a catalog at customer level apply at that customer and to all sites below the customer.

    Also:

    • An entitlement profile can't be more restrictive than its associated entitlement catalog.
    • An entitlement catalog can't be more restrictive than an entitlement catalog at a higher level of the hierarchy.

  6. Add device groups:

    Important

    While one entitlement profile can have many device groups, device types in those groups must be unique across these groups. The same device can't be added to more than one device group.

  7. Click the Plus icon (+) to add more device groups to the entitlement catalog.

  8. Click Save to add the new catalog.

    Next steps:

Catalogs

Create an Entitlement Catalog

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

  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.

HcsEntitlementCatalogDAT

Model Details: data/HcsEntitlementCatalogDAT

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
Conferencing
  • Field Name: conferencing
  • Type: Boolean
Collaboration
  • Field Name: collaboration
  • Type: Boolean
Fixed Mobile Convergence
  • Field Name: fmc
  • 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