Vendor Consolidation Level and Access Level
This page covers the following aspects of adding a custom/third-party enforcement:
>Vendor consolidation levels and their supported values
>Vendor access levels and their supported values
>Supported combinations of vendor consolidation levels and vendor access levels
>Examples of how data types, consolidation levels, and access level define the appearance of enforcement attributes in GUI.
Vendor Consolidation Level (isvConsolidationlevel)
The isvConsolidationlevel element contains parameters to define how the enforcement attribute value is aggregated at various levels.
The available consolidation level attributes are:
>Product Access Level (productAccessLevel): When set to true, the value of the enforcement attribute is aggregated across all features in a product. The enforcement attribute must be present in all the associated license models.
>Entitlement Access Level (entitlementAccessLevel): Must be set to false for custom enforcements.
>Entitlement Item Access Level (entitlementItemAccessLevel): When set to true, the value of the enforcement attribute is aggregated across all features in line items of an entitlement. The enforcement attribute must be present in all the associated license models.
>Activation Access Level (activationAccessLevel): When set to true, the value of the enforcement attribute is aggregated across all features in an activation. The enforcement attribute must be present in all the associated license models.
Note:
All features in a product, entitlement, and activation must have similar types of license models, that is similar set of attributes in all license models for successful consolidation of enforcement attributes.
How to configure consolidation levels?
Using the above consolidation attributes, you can configure the following types of consolidations:
Consolidation Level |
How to configure it? |
---|---|
No Consolidation The enforcement attribute value is not aggregated. |
Set the following: >productAccessLevel = false >entitlementAccessLevel = false >entitlementItemAccessLevel = false >activationAccessLevel = false |
Item Level Consolidation The enforcement attribute value is aggregated across all line items in an entitlement.
|
Set the following: >productAccessLevel = false >entitlementAccessLevel = false >entitlementItemAccessLevel = true >activationAccessLevel = false |
Product and Item Level Consolidation
The enforcement attribute value is aggregated across all products—both while defining a catalog and creating an entitlement. |
Set the following: >productAccessLevel = true >entitlementAccessLevel = false >entitlementItemAccessLevel = true >activationAccessLevel = false |
Item and Activation Level Consolidation
The enforcement attribute value is aggregated across all products—when defining a product catalog and activating the product. |
Set the following: >productAccessLevel = false >entitlementAccessLevel = false >entitlementItemAccessLevel = true >activationAccessLevel = true
When activationAccessLevel is true, you must set the endUserPermission value in the associated license model to WRITE. >endUserPermission = WRITE |
Vendor Access Level (isvAccesslevel)
Defines if the enforcement attribute is visible, read-only, writable, or mandatory at various levels of licensing lifecycle - license model, feature, product, entitlement, and activation. The value at each level depends on the combination of consolidation levels.
Possible values at each level:
>NONE: The attribute is not visible at the given level.
>READ: The attribute is read-only at the given level.
>WRITE: The attribute is writable at the given level.
>MANDATORY: The attribute is mandatory to set at the given level.
IMPORTANT
The values of isvAccesslevel are used as default in license model API endpoints.
The available access levels are:
>licenseModelAccessLevel: Determines if the enforcement attribute is visible, read-only, writable, or mandatory at the license model level. The licenseModelAccessLevel is valid for every consolidation level.
>featureAccessLevel: Not Applicable. Since enforcement attributes do not appear at feature level, this value is ignored.
>productAccessLevel: Determines if the enforcement attribute is visible, read-only, writable, or mandatory at the product level.
>entitlementAccessLevel: Determines if the enforcement attribute is visible, read-only, writable, or mandatory at the entitlement level. Not applicable for any combination of consolidation levels.
>entitlementItemAccessLevel: Determines if the enforcement attribute is visible, read-only, writable, or mandatory at the entitlement-product relationship level. Not applicable when isvConsolidationlevel is false.
>activationAccessLevel: Determines if the enforcement attribute is visible, read-only, writable, or mandatory at the activation level.
Supported Combinations of isvConsolidationlevel and isvAccesslevel
|
No Consolidation |
Item Level Consolidation (Entitlement Item Access Level = true) |
Product and Item Level Consolidation (Product Access Level = true Entitlement Item Access Level = true) |
Item and Activation Level Consolidation (Entitlement Item Access Level = true Activation Access Level = true) |
---|---|---|---|---|
licenseModelAccessLevel |
NONE, READ, WRITE, MANDATORY |
NONE, READ, WRITE, MANDATORY |
NONE, READ, WRITE, MANDATORY |
NONE, READ, WRITE, MANDATORY |
featureAccessLevel |
NA |
NA |
NA |
NA |
productAccessLevel |
NA |
NA |
READ, WRITE, MANDATORY |
NA |
entitlementAccessLevel |
NA |
NA |
NA |
NA |
entitlementItemAccessLevel |
NA |
READ, WRITE, MANDATORY | READ, WRITE, MANDATORY | READ, WRITE, MANDATORY |
activationAccessLevel |
NA |
NA |
NA |
READ, WRITE, MANDATORY |
Sentinel EMS Vendor Portal Examples
This section contains examples demonstrating how screens in Sentinel EMS vendor portal appear for various data types (date, numeric, list, etc.) and for various consolidation levels and access levels.
No Consolidation
The License Model screen where enforcement attributes are not consolidated:
Product and Item Level Consolidation
The Enforcement Extension section of the Products screen:
Item Level Consolidation
An example of the Product Attributes tab, which appears on the Entitlements screen under the Associated Products/Product Suitesection.
Item and Activation Level Consolidation
A snippet from the Activation screen:
Parent Attributes
In the License Model screen, “Start Date” and “End Date” have the parent attribute “Start From Activation Date” with the value "No":
In the License Model screen, "License Duration in Days" has the parent attribute “Start From Activation Date” with the value "Yes":