.. _entitlement: Introduction to entitlement ---------------------------- .. _21.1|VOSS-795|EKB-8087: .. tip:: :ref:`use-action-search-to-navigate-automate` Overview ........... Entitlement in 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, you can choose whether to assign an entitlement profile. .. 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 Entitlement workflow in Automate ................................. The diagram provides an overview of the entitlement set up workflow: .. index:: Flowchart;Setting up Entitlement .. 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 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 | Automate, but in some cases, the default is based on | | | settings outside of Automate, depending on how users are | | | added to Automate. See Default Entitlement Profiles | +----------------------+---------------------------------------------------------------+ Default entitlement profile .............................. Entitlement defaults work differently depending on how a user is added to 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 User | portal/loader by the administrator who adds the | | | user. When using Quick Add User 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. | | | 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** checkbox 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** checkbox selected (set to true), in the user's hierarchy tree, then the user will inherit this entitlement profile. * If the **Default Profile** checkbox 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.