Creating an Entitlement

Creating a LDK Entitlement

When you create a LDK Entitlement, you can:

Specify the Products for which you want to create the Entitlement.
Edit the license terms for individual Features.
Edit the content and layout of the memory data stored in Sentinel protection keys.

To create a LDK Entitlement:

From the Protection Type drop-down list, select LDK License.
(Optional). In the Customer field, specify a Customer for which you are creating the Entitlement.

Enter the first few characters of the Customer name (alphanumeric) or the Customer ID (numeric). A list of matching Customers is populated. Select a name from the list or click <<ADD NEW>> to create a new Customer.

If the list displays multiple customers having the same name, select any one of them. A pop-up appears, which displays additional information (e-mail, CRM ID, Ref ID, Customer ID) about the customer. Select the relevant customer and click OK.

To perform an advanced search, click .

If the Customer has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list. If the Customer does not have any e-mail ID, you can leave this field blank.
(Optional) In the Channel Partner field, type the first few characters of the channel partner name. A list of matching names is populated. Select a name from the list or click <<ADD NEW>> to create a new channel partner. To perform an advanced search, click .

On the Creating a Channel Partner page, you associate product(s) with channel partners. When such a channel partner is entered here, only products associated with that channel partner can be added to the entitlement (see step 13).
If the Channel Partner has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list.
(Optional) To add reference IDs, click the Add Ref ID link. The Ref ID 1 and Ref ID 2 fields appear. In these fields you can enter information that identifies the Entitlement in another system. For example, the order code in your company's ERP system.
(Optional) To add a description to the Product, click the Add Entitlement Notes link. The Comments field appears. In this field, you can enter text to provide additional information about the Product (maximum length 500 characters).
Enter Start Date and End Date for the Entitlement. To extend the end date indefinitely, select the Unlimited check box.
In the Entitlement Type field, specify one of the following:
- Hardware Key—Writes the Entitlement items to one or more Sentinel HL keys.
- Product Key—Associates the Entitlement items to one or more Product Keys.
- Protection Key Update—Enables changes to be made to the license data stored in deployed keys.
To select the products to be included in the entitlement, click + Add Product. The Product Selection pop-up appears.
When you click the + Add Product button, products associated with the channel partner are displayed so that they can be included in the entitlement. However, if either of the following conditions is true, product filtering will fail and all products will be displayed.
- The master key is unplugged and multiple batch codes are present in the EMS database.
- The master key is plugged and either feature 12 license has expired or channel partner module is not present in the master key.
You may also see the Add Products From State button on this pane. This button is available only if your Sentinel EMS administrator has selected the Allow adding Products from State check box in the Admin Console. This allows you to copy the Product details from a previous C2V file or Key ID to the Entitlement.
Select one or more Products.
Click Add Products to Entitlement. The selected Products are added to the Entitlement.
The Product specifications must be compatible with the Entitlement type. For example, you cannot add a Product that must be locked to a Sentinel HL key to an Entitlement for Sentinel SL keys.
- By default, only the Features for which license terms need to be defined are displayed. You can change the display option from the Show drop-down list. Following options are available:
  - All: Details of all Features in all the Products are displayed.
  - Mandatory: Only mandatory (not excludable) Features are displayed.
  - Excludable: Only the Features that were specified as Excludable at the time the Product was created are displayed.
  - Configurable: Only the Features for which license terms have not been be defined are displayed. The License Terms for such Features are shown in orange. After the values are defined, the License Terms are shown in green.
- Configure rehosting for Products for which rehosting needs to be specified during Entitlement creation. For such Products, a drop-down list appears in the Rehost column. Select a value from the following:
  - Enable—Enable rehosting for the Product.
  - Disable—Disable rehosting for the Product.
  - Leave as it is—Retain the value of rehost as is in the Protection key.
- If you want to exclude a Feature from the Product, select the Exclude check box. Only Features that were specified as Excludable at the time the Product was created can be excluded.
- Select a Product and click Memory to display the Memory pop-up. For more information about editing memory data, see Editing Memory Data During Entitlement Generation.
For each Feature for which license term values have not been defined, an orange link appears in the License Terms column. Click this link to specify the required values for the Entitlement. After the values are defined the License Terms are shown in green.

For multiple Features that require the same licensing details, select the Features and click Configure to display the Configure License Terms pop-up. For detailed information on specifying license terms, see Defining License Terms for an LDK Product.

The Entitlement can be added to the production queue or produced only after the license term values have been defined for all the Features in all the Products included in the Entitlement.

Save as Draft, Queue, or Produce the Entitlement:
- Save as Draft—save the Entitlement in Draft state until it is ready to be added to the production queue.
- Queue—make the Entitlement available for production.
- Produce—produce the Entitlement immediately.

Creating an Entitlement from a Sentinel Key / Transferring License from an Existing Sentinel Key to a New Key

Sentinel EMS allows you to create an Entitlement from the current state of a Sentinel Key using C2V file or Key ID. In the new key created as a result, the Product details (such as Features included, License Terms, memory data, remaining days and count, etc.) remain same as in the old key. For example, if a Product in the key was originally meant to be used for 100 days and the user has already used it for 40 days, then the new Product will have a term of 60 days. This feature is useful in the following example scenarios:

customer's machine has got corrupted and the V2C file is not available
customer's Sentinel HL key is damaged, lost, or its battery has exhausted

Note the following points:

You cannot add or remove Products in the list of Products drawn from the previous key
You cannot change license terms
You cannot edit memory data. Also, memory segments of individual Products cannot be viewed using the Memory tab. When you click the Memory tab, the consolidated view of memory segments of all Products is displayed. However, you can use the Map button in the Memory Segment window to get an idea of individual memory segments.

This feature is available only if your Sentinel EMS administrator has enabled the Allow adding Products from State option in the Admin Console. If this option is selected, you will see Add Product From State button in the Product Details pane. This button enables you to add Product details from a previous C2V file or Key ID.

To create Entitlement using C2V / Key ID:

From the Protection Type drop-down list, select LDK License.
(Optional). In the Customer field, specify a Customer for which you are creating the Entitlement.
Enter the first few characters of the Customer name (alphanumeric) or the Customer ID (numeric). A list of matching Customers is populated. Select a name from the list or click <<ADD NEW>> to create a new Customer.
If the list displays multiple customers having the same name, select any one of them. A pop-up appears, which displays additional information (e-mail, CRM ID, Ref ID, Customer ID) about the customer. Select the relevant customer and click OK.
To perform an advanced search, click .
If the Customer has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list. If the Customer doesn't have any e-mail ID, you can proceed by leaving this field blank.
(Optional) To specify a Channel Partner, click the Add Channel Partner link. The Channel Partner field appears. Type the first few characters of the Channel Partner name. A list of matching names is populated. Select a name from the list. To perform an advanced search, click .
If the Channel Partner has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list.
(Optional) To add reference IDs, click the Add Ref ID link. The Ref ID 1 and Ref ID 2 fields appear. In these fields you can enter information that identifies the Entitlement in another system. For example, the order code in your company's ERP system.
(Optional) To add a description to the Product, click the Add Entitlement Notes link. The Comments field appears. In this field, you can enter text to provide additional information about the Product (maximum length 500 characters).
Enter Start Date and End Date for the Entitlement. To extend the end date indefinitely, select the Unlimited check box.
In the Entitlement Type field, specify one of the following:
- Product Key—Associates the Entitlement items to one or more Product Keys.
- Hardware Key—Writes the Entitlement items to one or more Sentinel HL keys.
- Protection Key Update—Enables changes to be made to the license data stored in deployed keys.
In the Product Details pane, click Add Product From State. The Add Product From State pop-up appears.
In this pop up, do one of the following:
- Select Key ID and provide the Key ID in the text box.
- Select C2V File and click to browse and select the C2V file.
Click Load.
All Products available in the previous Entitlement (related to the C2V file or Key ID) are listed in the Product Details pane.
You cannot edit the memory data. However you can see a consolidated view of memory segments of all Products in the Entitlement by clicking the Memory tab. You can use the Map button in the Memory Segment window to view individual memory segments.
Save as Draft, Queue, or Produce the Entitlement:
- Save as Draft—save the Entitlement in Draft state until it is ready to be added to the production queue.
- Queue—make the Entitlement available for production.
- Produce—produce the Entitlement immediately.

Creating a Cloud Entitlement

When you create a Cloud Entitlement, you can:

Specify the Products for which you want to create the Entitlement.
Edit the license terms for individual Features.

To create a Cloud Entitlement:

From the Protection Type drop-down list, select Cloud License.
The Sentinel LDK License option is displayed as default. The Cloud License option is available only when your Batch Code is cloud enabled.
(Optional). In the Customer field, specify a Customer for which you are creating the Entitlement.
Enter the first few characters of the Customer name (alphanumeric) or the Customer ID (numeric). A list of matching Customers is populated. Select a name from the list or click <<ADD NEW>> to create a new Customer.
If the list displays multiple customers having the same name, select any one of them. A pop-up appears, which displays additional information (e-mail, CRM ID, Ref ID, Customer ID) about the customer. Select the relevant customer and click OK.
To perform an advanced search, click .
You can leave this field blank if you want to save the Entitlement as Draft. If you intend to deploy the Entitlement, ensure that you do the following:
- Specify a Customer.
- The specified customer has at least one contact e-mail.
If the Customer has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list.
(Optional) In the Channel Partner field, type the first few characters of the channel partner name. A list of matching names is populated. Select a name from the list or click <<ADD NEW>> to create a new channel partner. To perform an advanced search, click .

On the Creating a Channel Partner page, you associate product(s) with channel partners. When such a channel partner is entered here, only products associated with that channel partner can be added to the entitlement (see step 13).
If the Channel Partner has multiple contact e-mail IDs, you can choose one from the E-mail drop-down list.
(Optional) To add reference IDs, click the Add Ref ID link. The Ref ID 1 and Ref ID 2 fields appear. In these fields you can enter information that identifies the Entitlement in another system. For example, the order code in your company's ERP system.
(Optional) To add a description to the Product, click the Add Entitlement Notes link. The Comments field appears. In this field, you can enter text to provide additional information about the Product (maximum length 500 characters).
In the Provisioning Container field, select the New radio button. This will create a new Provisioning Container ID for the Entitlement.
The Update Existing radio button is used to modify an existing Cloud Entitlement. See Creating an Entitlement for details.
In the Deployment Mode field, specify whether your protected application will be hosted on cloud or will be installed locally. See Defining Deployment Mode and Other Details for details.
To select the product(s) to be included in the entitlement, click + Add Product.

When you click + Add Product, products related to the channel partner are displayed so that they can be included in the entitlement. However, if either of the following conditions is true, product filtering will fail and all products will be displayed.

The master key is unplugged and multiple batch codes are present in the EMS database.
The master key is plugged and either feature 12 license has expired or channel partner module is not present in the master key.

On the Product Selection pop-up window, select one or more products.
Click Add Product to Entitlement. The selected Products are added to the Entitlement and displayed in the Product Details pane.
By default, only the Features for which license terms need to be defined are displayed. You can adjust the display by selecting an option from the Show drop-down list. The following options are available:
- All: Details of all Features in all the Products are displayed.
- Mandatory: Only mandatory (not excludable) Features are displayed.
- Excludable: Only the Features that were specified as Excludable at the time the Product was created are displayed.
- Configurable: Only the Features for which license terms have not been be defined are displayed. The License Terms for such Features are shown in orange. After the values are defined, the License Terms are shown in green.
For each Feature for which license term values have not been defined, an orange link appears in the License Terms column. Click this link to specify the required values for the Entitlement. After the values are defined the License Terms are shown in green.

For multiple Features that require the same licensing details, select the Features and click Configure to display the Define License Terms for a Cloud Entitlement pop-up. For detailed information on specifying license terms, see Defining License Terms for a Cloud Product.

The Entitlement can be deployed only after the license term values have been defined for all the Features in all the Products included in the Entitlement.

To finalize the entitlement, click one of the following buttons :
- Save as Draft—Saves the Entitlement in Draft state until it is ready to be deployed.
- Deploy—The Entitlement is deployed to the Sentinel Cloud Connect server.
If the Sentinel Cloud Connect server is temporarily unreachable, you may save the Entitlement as a draft and deploy it later.

After the Entitlement is deployed, the new Entitlement is displayed as the first item in the Entitlements list. A corresponding Provisioning Container with a unique Provisioning Container ID (PC ID) is created for the Entitlement. You can view the PC ID as a link in the Entitlement Details pane. Click the link to view the PC ID details. (See Managing Provisioning Containers.)