Model: data/HcsEntitlementCatalogDAT

Catalogs

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

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:

An entitlement catalog must exist at Provider level.

Device groups you want to add to a catalog at the current hierarchy must first be added to a catalog higher in the hierarchy. For example, before adding a device group to a catalog at Customer level, you'll need to add the device group to a catalog at Provider or Reseller level.

To add an entitlement catalog:

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

Note

You can only create one entitlement catalog at each hierarchy.

Go to (default menus) Entitlement > Catalogs.

Click Add.

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

Enter a name and optionally, a description.
Choose the services to include in this entitlement catalog. Options are: Voice, Voicemail, Presence, Extension Mobility, Single Number Reach, Conferencing, Collaboration.
Specify the maximum number of devices allowable for the entitlement catalog. The maximum number can't exceed the total of the maximums for all the device groups included in the 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.

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.

Click the Plus (+) icon at Device Groups.
From the Device Group drop-down, choose a device group to include in the entitlement catalog.
Specify the maximum number of devices allowed for the selected device group. The maximum number for any device group can't exceed the maximum number of devices for the catalog.

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

Click Save to add the new catalog.

Next steps:

Create entitlement profiles, at or below the hierarchy level of the entitlement catalog (see: Create an Entitlement Profile).

HcsEntitlementCatalogDAT

Model Details: data/HcsEntitlementCatalogDAT

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title			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