Creating Entitlements
|
>Entitlements for Sentinel LDK CL Service (Produce and Push) |
Entitlement Status
The Status attribute available on the Entitlements page specifies the status of an entitlement:
>Draft: When an entitlement is first created, it is saved as a draft that you can edit or delete.
>Completed: A draft entitlement must be marked as completed before it can be activated.
>Disabled: A disabled entitlement cannot be updated
>Closed: Indicates that the entitlement is permanently disabled and no action can be performed on it. You cannot enable a closed entitlement.
Creating an Entitlement
You create an entitlement from the Entitlements page.
To create an entitlement:
1.Prerequisite: Make sure that the required products and features are available for inclusion in the entitlement. For details, see Creating a Feature and Creating a Product.
1.From the navigation pane, select Entitlements to view the Entitlements page.
2.Ensure that the Test Entitlement Mode is set as needed.
•For production purposes, set Test Entitlements to Off.
•For testing purposes, set Test Entitlements to On. For more information, see Test Entitlement Mode.
3.Click the Add Entitlement button. The Add Entitlement page opens.
4.Assign Customers, Contacts, Channel Partners, and Market Groups.
5.Define Entitlement Attributes.
6.Associate Products. Products that are added to an entitlement are known as line items.
a.In the Associate Products / Product Suite pane, click the products that you want to add to the entitlement. The items move to the Associated Products pane.
TIP You can filter the displayed list using the Search parameters, which are based on product attributes.
b.In the Associated Products pane, modify the Line Item Attributes as needed.
c.Expand each product to view and modify the Associated Features as needed.
–(Optional) Click the Configure Features button to display a multiple-feature configuration bar in the first row. Then click the check box for the features whose attributes you want to define or modify. Using the options in the bar, configure the settings for all selected features as needed. Despite its name, this bar is available for single features, as well.
–(Optional) Click the Configure License Model button to modify the license model attributes as needed. Then click Save to close the window.
d.Click the Associated Memory tab to view and configure as needed.
e.Click the Product Attributes tab to view and configure as needed.
7.(Optional) If memory files are associated, click the Associated Memory tab to view them. If Allow Overwrite was selected during product creation, you can modify the text as needed.
8.Click Save to save the entitlement as draft. The entitlement is added to the list of entitlements. By default, the entitlement is added to the top of the list, but this may change according to the grid sorting rules.
9.Do one of the following:
•Finalize the entitlement and make it available for activation
Complete in the Actions column.
•Create a batch entitlement by following the steps in Configuring a Batch Entitlement.
Assign Customers, Contacts, Channel Partners, and Market Groups
The Assign Customer / Channel Partner pane displays the attributes that are used to specify the ownership details of an entitlement. You can use this pane to specify the customer, contact, channel partner, and market group details. The following table explains the attributes that are available in this pane.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
|
Market Group (Visible only if the logged-in user is associated with more than one market group) |
List of Market Groups to which the logged in user (customer or contact) belongs. Each market group specifies a target market for specific catalog elements and their entitlements. Users can work only with catalog elements and entitlements in their own market group. If the logged in user is associated with only one market group, then the system automatically picks the logged in user's market group. If the logged in user is not associated with any market group, then the system uses a default value that is not visible to the user. |
Required |
>Any market group in the list >Any market group in the list that is allocated for the required enforcement |
| Customer |
Name of the customer. This attribute is not case-sensitive. Entering the first few characters displays the matching entries. Select a customer from the displayed list or click the |
Optional
|
>Alphanumeric >1 to 255 characters |
| Customer ID | The customer ID defined in Sentinel EMS is displayed automatically. This field is disabled and cannot be modified. |
Mandatory for: |
>Unique >Alphanumeric |
| Contact Email |
Email of the contact. Enter the first few characters to display the matching entries. Select a contact email from the displayed list or click the If you plan to use Produce and Push to activate the entitlement, select an administrator contact. |
Optional |
>Valid email address |
| Partner Name | Name of the channel partner. Entering the first few characters, displays the matching entries. Select a channel partner from the displayed list or click the  Add Channel Partner button to create a new one. For details, see Channel Partner Attributes. |
Optional |
>Alphanumeric >1 to 250 characters |
| CC Email |
Displays the additional email addresses to which the entitlement confirmation email must be sent. You can edit the value only if the CC Email Change Allowed property is set to Yes in the Administration Console. For more information, see CC Email Change Allowed. |
Optional |
>Up to 15 email addresses >Add email addresses by typing or by selecting from auto-complete. Press Enter after each manually entered email address. |
| User Registration |
Specifies whether end user registration is required. NOTE For Sentinel HL keys, it is recommended to select Optional or None. |
Required |
>Mandatory: The end user must provide registration details when logging on using the EID or product key. >Optional: The end user is prompted to provide registration information or to register later. >None: The user registration page does not appear. |
Define Entitlement Attributes
Entitlement-related attributes are specified in the Define Entitlement Attributes pane, described below.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
|
Start date for the entitlement. See also: No Start Date check box |
Required |
A start date entered manually or selected from the calendar | |
| No Start Date check box |
Excludes the start date. Select this check box for licenses that need to support embedded devices that do not have a system clock, for example.
Note: >If license model dates are not configured during entitlement creation, then the end date will be one year after the current date. >If license model dates are configured during entitlement creation, then the end date will be the same as the one defined during configuration. >The value that is assigned to the No start date check box while configuring a license model in an entitlement overrides the value defined for the No start date check box while creating the license model using Copy. |
Optional | (Selected or Cleared) |
|
End date for the entitlement. To specify an end date, do one of the following: >Click the calender button and select the end date. The number of days for the entitlement is automatically calculated and displayed. >In the Days box, enter the number of days for the entitlement. The end date is automatically calculated and displayed.
Note: You cannot activate an entitlement if the End Date has passed. |
Required |
An expiry date or Never Expires check box | |
| Days |
The number of days during which the entitlement can be activated. The end date is automatically calculated and displayed. |
Optional |
Maximum: 12000 |
|
Indefinitely extends the end date. |
Optional |
(Selected or Cleared) | |
|
EID |
Entitlement ID. A unique identifier for an entitlement. If not provided, Sentinel EMS automatically generates an EID after creating an entitlement. You can modify the EID only if the Allow Manual Creation of EID and PKID check box is selected in the Administration Console. |
Optional
|
>Alphanumeric >Special characters > 6 to 60 characters >Cannot contain spaces |
|
External ID |
External reference identifier that uniquely identifies the entitlement in an external system. |
Optional |
>Unique across Sentinel EMS for all entitlements. >0 to 60 characters |
|
Ref ID 1 |
Reference identifier that identifies the entitlement in an external system. |
Optional |
>0 to 100 characters |
|
Ref ID 2 |
Reference identifier that identifies the entitlement in an external system. |
Optional |
>0 to 100 characters |
|
If Allow Activation is set to Yes, allows the specified type of user to activate the entitlement.
You set the type of user in the By box. |
Required |
Allow Activation: Yes OR No Default: Yes
By: >All Users (Default): Any user that has access to the entitlement can activate the entitlement. Vendor users require activation role permissions. >Vendor Only: Vendor users with activation role permissions can activate the entitlement. On the Sentinel EMS customer portal, the entitlement is visible, but cannot be activated. |
|
|
Allow Revocation |
Required |
Not supported |
|
|
Specifies that all products (line items) that are part of this entitlement are activated at the same time.
The following conditions must be met to activate an entitlement as a whole: > The activation method of all line items in the entitlement must be the same. >The quantity of all line items must be same. >All line items must have the same Fixed Quantity. > All line items must use the same enforcement. >For unlocked products, set Entitlement as a Whole to Yes. |
Required |
Yes OR No Default: |
|
|
Send Notification |
Send a notification to the contact email after the entitlement is created. |
Required |
Yes OR No Default: Yes |
Associate Products
Use the Associate Products / Product Suites pane displayed below to associate products with the entitlement you are creating.
Sentinel LDK example
Line Item Attributes
Product-related attributes are specified in the Associated Products pane, described below.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
| Product / Product Suite | Name of the associated product. | Required | Read-Only |
| Product ID | Numeric identifier for the product. | Required | Read-Only |
| Available Quantity |
Total number of available activations. You must use the same value in all line items for: |
Required |
An integer > 0 or Unlimited , the quantity allowed is only 1. |
| Start Date |
The date (day, month, and year) before which the licensed software cannot be run. By default, the start date for an associated product is same as the Start Date in the entitlement. You can specify different dates for a product by modifying the date in the line item. >If a start date is defined in the license model, then this date is also displayed for the entitlement. However, if the license model start date is earlier than the current date, then the current date is displayed as the start date. >You can select a start date that is earlier than the current date. |
Required |
Do one of the following: >Enter a valid date. >Select the No Start Date check box check box to exclude the start date. |
| End Date |
The date (day, month, and year) after which the licensed software cannot be run. By default, the end date for an associated product is same as the End Date in the entitlement. You can specify different dates for a product by modifying the date in the line item. If the license model end date is a future date, then that end date is displayed by default as the end date for the product. |
Required |
Do one of the following: >Enter a valid date. >Enter the maximum number of days. >Select the Never Expires check box check box to extend the end date indefinitely. |
|
Action > |
Removes the association with the entitlement. The product moves from the list of Associated Products back to the list of Available Products. |
Optional | N/A |
DeleteAssociated Features
Feature-related attributes are specified in the Associated Features tab, described below.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
| Feature Name | Name of the associated feature. | Required | Read-Only |
| Include Feature |
Toggle button that specifies if a feature is included in the entitlement. Note: Although this option is visible for Sentinel Fit, it is not supported and should not be used. For best results, leave Included (Optional) as is. |
Required | Yes or No |
| License Model |
The license model associated with the feature. |
Required |
A valid license model |
| Start Date |
The date (day, month, and year) before which the licensed feature cannot be run. By default, the start date for an associated product is same as the Start Date in the entitlement. You can specify different dates for a product by modifying the date in the line item. >If a start date is defined in the license model, then this date is also displayed for the entitlement. However, if the license model start date is earlier than the current date, then the current date is displayed as the start date. >You can select a start date that is earlier than the current date. |
Required |
Do one of the following: >Enter a valid date. >Select the No Start Date check box check box to exclude the start date. |
| End Date |
The date (day, month, and year) after which the licensed feature cannot be run. By default, the end date for an associated product is same as the End Date in the entitlement. You can specify different dates for a product by modifying the date in the line item. If the license model end date is a future date, then that end date is displayed by default as the end date for the product. |
Required |
Do one of the following: >Enter a valid date. >Enter the maximum number of days. >Select the Never Expires check box check box to extend the end date indefinitely. |
| Apply License |
Specifies how to apply the license model attributes to the feature. If the license model was set to Define in Entitlement when creating the product, you must set the value in this field. Which option is best? You select an option based on what you are trying to achieve. For new products, although you can select any of the options, for the most flexibility when updating the expiration date, number of days, or execution count license terms, we recommend selecting System-specified. System-specified enables you to resell the product to the same customer without changing the product properties. For example, suppose you sell a product with a one-year subscription. At the end of the year, you can renew the subscription by setting the new expiration date in the entitlement, without changing the product properties in Sentinel EMS. If you need to update the concurrency or change the license model for the same customer's existing product, select Add or Overwrite instead. Note: If you receive an error message related to applying a license, you may need to select another Apply License option. |
Required |
One of the following: >System-specified: (Default) Enables Sentinel EMS to automatically apply the best option for the license—Add or Overwrite—based on the specified attributes. When applying license updates to activated products, this lets you quickly update the expiration date, number of days, or execution count (depending on the license model) without extensive manual changes. You must retain the existing concurrency values, including the number of concurrent instances (number of concurrent seats). If you must select another license model or change any concurrency or accessibility values post-activation, you need to create a new entitlement. >Add: Adds the specified license model attributes to the feature. When applying license updates to activated products, this option adds to the existing values. The "add" mechanism is applied based on the attribute values set in the license model during the update. To retain the current value for the license terms (expiration date, number of days, or execution count) or concurrent instances, set the relevant value to 0. This instructs Sentinel EMS not to add anything to those values. >Overwrite: Modifies the license model attributes associated with the feature by overwriting the existing values with the updated values. When applying license updates to activated products, this option overwrites the existing values with the values specified in the license model during activation. |
|
Action > |
Button used to open the Configure License Model dialog box. Enables you to view and configure the license model associated with the selected feature.
Tip: In the Associated Features pane, you can select the check box for one or more features and click the Configure License Model button to configure and apply the same license model to all selected features simultaneously.
|
Optional | N/A |
Configure License Model
Associated Memory
Memory-related attributes are specified in the Associated Memory tab.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
| File Name | A descriptive name of the memory file. | Required | Read-Only (Set when creating the Memory file.) |
| File ID |
Integer that identifies the memory file and is used by your application to refer to that file. |
Required | Read-Only (Set when creating the Memory file.) |
| File Type | Type of data stored in the memory file. | Required | Read-Only (Set when creating the Memory file.) |
| Offset | The hexadecimal starting point of the memory file. | Optional |
Read-Only (Set when creating the Memory file or when you Associate Memory Files with a product.) |
| Size (Bytes) |
Size of the memory file in bytes. |
Optional
|
Read-Only (Set when creating the Memory file or when you Associate Memory Files with a product.) |
| Text |
The memory data in text format. You can add or edit text if the Allow Overwrite check box was selected when creating the product containing the memory file. NOTE The combined value of Text and Offset must not exceed the memory file Size (Bytes). |
Optional |
Read-Only (Set when creating the Memory file or when you Associate Memory Files with a product.) OR Text with a maximum size that does not exceed the following: User-defined memory: >Sentinel SL keys: 65535 bytes >Sentinel HL key version 6.x keys: 65535 bytes >Sentinel HL key version 4.x keys: 25944 bytes Default memory: >Default (Read/Write): 4032 bytes* >Default (Read-Only): 2048 bytes* |
| Apply Memory |
Specifies how to attach the memory file to the product. Sentinel EMS applies memory files in the order in which they are added to the product. |
Required |
Read-Only (Set to one of the following when you Associate Memory Files with a product.): >Add >Overwrite >Delete For more information about these values, see Apply Memory. |
Product Attributes
Product-related attributes are specified in the Product Attributes tab.
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
| Activation Method |
Specifies whether a finite or unlimited number of activations is available. >Fixed. The provided quantity can be consumed in multiple activations, and each activation will consume the specified fixed quantity. By default, the Fixed quantity is 1. >Unlimited. The user can perform an unlimited number of activations for the product. Default: Fixed |
Required | Fixed or Unlimited |
| Locking Type | The Locking Type value specified during product creation. | Required | Read-Only |
| Rehost | The Rehost value specified during product creation. If Define in Entitlement was specified, you must set the value in this field. | Required |
One of the following: >Enable >Disable >Leave As Is |
Test Entitlement Mode
Sentinel EMS enables you to work in the Test Entitlements mode for testing purposes. (Not recommended for use with production devices.)
You can use test entitlements to verify that:
>License models, features, products are appropriately defined.
>Entitlements are being generated successfully.
>Entitlement certificates and license certificates are generated correctly and are sent to the end user.
>The generated license code or string works for the products.
The following is true for test entitlements:
>You can create test entitlements for products that are marked as Draft or Completed.
>You can delete a test entitlement.
To create a test entitlement:
1.From the navigation pane, select Entitlements to view the Entitlements page.
2.Set Test Entitlements to On. By default, the Test Entitlements mode is switched off.
NOTE When working with test entitlements, real entitlements are not listed (and vice versa). To move back to real entitlements, set the Test Entitlements mode back to "Off".
3.Create the test entitlement as defined in Creating an Entitlement.
Entitlements for Sentinel LDK CL Service (Produce and Push)
The process of creating an entitlement for cloud licensing (that you plan to activate using Produce and Push) is identical to creating any other entitlement with some minor exceptions described in this section.
TIP If you are working only with Sentinel LDK CL Service (in other words, you are not using Sentinel HL or Sentinel SL keys or any enforcement other than Sentinel LDK), you can ease maintenance by changing the global settings in the Entitlement Configuration pane of the Administration Console as follows:
>Set Entitlement as a Whole to Yes.
>Set Allow Activation By to Vendor Only.
To create an entitlement for Sentinel LDK cloud licensing for activation using produce and push:
1.(Optional) If you plan to delegate account management to customers via the Sentinel EMS customer portal, an administrator contact must be associated with the customer. Add an administrator contact if one does not exist and associate that contact with the customer. For details, see Contacts.
The administrator contact is responsible for managing accounts and registered machines, as described in Accounts. Although you can associate an administrator contact with the customer after you create the entitlement, we recommend handling this in advance for ease of maintenance.
2.Start creating an entitlement as described in Creating an Entitlement.
3.Assign a customer to the entitlement as described in Assign Customers, Contacts, Channel Partners, and Market Groups. If the customer is associated with an administrator contact, the Contact Email address is automatically populated in the entitlement.
4.If you did not configure the global settings as described in the tip above, then, in the Define Entitlement Attributes pane, expand Additional Attributes and set the following. Otherwise skip to the next step.
•Allow Activation to Yes ... By Vendor Only. This ensures that end users that access the Sentinel EMS customer portal cannot activate the products in the entitlement.
•(Recommended) Entitlement as a Whole to Yes. This enables you to activate all products at once without the need for selecting each product.
5.Associate products that include:
•One of the SL-AdminMode locking types. For details, see Locking Type.
•Features whose license model supports concurrency on a network and specifies the maximum number of concurrent instances. For details, see Configure License Model and Sentinel LDK Enforcement - License Models
6.Complete the entitlement as described in Creating an Entitlement.