.. _entitlement:
Introduction to Entitlement
----------------------------
.. _21.1|VOSS-795|EKB-8087:
Entitlement in VOSS Automate represents the set of rules for the suite of services
and devices available to specified users.
.. note::
Entitlement is an optional feature. When adding or updating a user or subscriber,
you can choose whether to assign an entitlement profile.
Setting up Entitlement
.......................
The diagram provides an overview of the entitlement set up workflow:
.. include:: entitlement-overview.uml
The table provides an example for how customers could define different entitlement
rule sets for their users:
================ ===============================================================
Customer A Creates entitlement rules that allows their end users to have:
* Voice service only
* Maximum of two devices:
* One device being a flavor of IP set
* One device being an analog set
Customer B Creates entitlement rules that allows their end users to have:
* Voice service
* Voicemail service
* Maximum of ten devices (limited to SIP sets)
================ ===============================================================
Entitlement Components
.......................
The table describes entitlement components. These are the
the VOSS Automate models and the rules that define how entitlement
works in the system:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+----------------------+---------------------------------------------------------------+
| Model | Description |
+======================+===============================================================+
| Device types | One or more physical devices, which may be grouped into |
| | device groups for entitlement purposes. |
| | |
| | Device types must correspond with supported product types |
| | available for the UC vendor, for example, Cisco or |
| | Microsoft. The device type data model is pre-populated |
| | with a snapshot of current product types. |
| | |
| | Provider admins can add, update, or remove device types. |
+----------------------+---------------------------------------------------------------+
| | A group of device types. The same device types may exist |
| | across different device groups |
| Device groups | |
| | Provider admins can add, update, or remove device groups. |
| | |
| | Reseller and customer admins can only view device groups. |
+----------------------+---------------------------------------------------------------+
| | Defines the supported device groups and available services |
| | at a particular hierarchy. Within a device group you also |
| | specify the maximum allowed total number of devices, and |
| | the maximum allowed number of devices in each device group |
| | in the catalog. |
| | |
| Entitlement catalogs | Provider admins can add, update, and delete entitlement |
| | catalogs at their hierarchy level and below. |
| | |
| | Reseller and customer admins can only view entitlement |
| | catalogs. |
+----------------------+---------------------------------------------------------------+
| | Defines a set of services, device groups, and device |
| Entitlement profiles | limits to which an end user may be subscribed. |
| | |
| | * Initial settings are inherited from the first |
| | entitlement catalog above it in the hierarchy. |
| | * Service and devices allowed in the profile can't exceed |
| | those allowed by the associated entitlement catalog. |
| | |
| | Provider admins can add, update, and delete entitlement |
| | profiles at their hierarchy level and below. |
| | |
| | Reseller and customer admins can only view entitlement |
| | profiles. |
+----------------------+---------------------------------------------------------------+
| | Default entitlement profiles can be set up and assigned in |
| Entitlement defaults | VOSS Automate, but in some cases, the default is based on |
| | settings outside of VOSS Automate, depending on how users are |
| | added to VOSS Automate. See Default Entitlement Profiles |
+----------------------+---------------------------------------------------------------+
Default Entitlement Profile
..............................
Entitlement defaults work differently depending on how a user is added to VOSS Automate:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+----------------------------+------------------------------------------------------------+
| User add option | Description |
+============================+============================================================+
| Bottom-up (UCM user sync) | This is based on the entitlement profile setting on the |
| | UCM server (publisher) the user is being synced from. The |
| | default entitlement profile is not used in this path. |
| | |
+----------------------------+------------------------------------------------------------+
| | This assigns the entitlement profile selected on the |
| Quick Add Subscriber | portal/loader by the administrator who adds the |
| | subscriber. When using QAS via the portal, it |
| | pre-populates the entitlement drop-down with the |
| | entitlement profile tagged as default. |
| | |
+----------------------------+------------------------------------------------------------+
| LDAP Top-down | Entitlement is determined by the entitlement profile |
| | setting on the LDAP User sync that is syncing the user in. |
| | The default entitlement profile is not used in this path. |
+----------------------------+------------------------------------------------------------+
| Admin Portal or loader | User added via User Management/Subscriber Management Add. |
| | This uses the value provided via the Admin Portal or |
| | loader. The default entitlement profile is not used in |
| | this path. |
+----------------------------+------------------------------------------------------------+
.. important::
When a user has an empty value for their Entitlement:
* If the user's Entitlement value is blank, and none of the Entitlement Profiles
in the User's hierarchy tree have the **Default Profile** check box selected
(set to true), then no Entitlement Profile is applied and no Entitlement
checking is done. This means all services and all phones are available to the
User.
* If the user's Entitlement value is blank, and one of the Entitlement Profiles
**does** have the **Default Profile** check box selected (set to true), in the
User's hierarchy tree, then the User will inherit this Entitlement Profile.
* If the **Default Profile** check box is cleared (set to false) from one
Entitlement Profile and added to another Entitlement Profile, then this new
Entitlement Profile will become the default Profile applied to all Users in
the hierarchy below whose Entitlement Profile is blank.
.. rubric:: Related Topics
*
.. raw:: latex
Add Device Type in the Core Feature Guide
.. raw:: html
Add Device Type
*
.. raw:: latex
Create Device Group in the Core Feature Guide
.. raw:: html
Create Device Group
*
.. raw:: latex
Create an Entitlement Catalog in the Core Feature Guide
.. raw:: html
Create an Entitlement Catalog
*
.. raw:: latex
Create an Entitlement Profile in the Core Feature Guide
.. raw:: html
Create an Entitlement Profile