Products

>What Is a Product?

>Prerequisites for Creating a Product

>Lifecycle Stages of a Product

>Product Status

>Creating a Product

>Actions for Products

New to Sentinel EMS?
See How to Use Sentinel EMS?

What Is a Product?

A product is a salable entity that contains one or more bundled features and memory files . A product can be a software application, hardware, or a service that you can sell or license according to your licensing plan. Features and memory files are optional, and you can apply one or both as needed.

Prerequisites for Creating a Product

>A role that includes Catalog (Namespace) permissions for the relevant namespace. (You cannot move an entity from one namespace to another.) At minimum, the vendor user needs the Add permission. For details, see Roles.

Lifecycle Stages of a Product

A product's lifecycle contains the following stages:

>Not Deployed: The product is not included in any entitlement.

>Deployed: The product is used in an entitlement.

Product Status

The Status attribute on the Products page indicates the status of a product.

Possible values:

>Draft: When you first create a product, it is saved as draft. You cannot create production entitlements for a draft product, however, you can create test entitlements for testing purposes.

>Completed: You can create entitlements for the product.

>End of Life: An obsolete product. You cannot edit or delete the product.

Creating a Product

When you create a product, you define the product attributes and associate any required features and memory files .

To create a product:

1.From the navigation pane, select Catalog > Products to view the Products page.

2.Click the Add Product button. The Add Product page opens.

3.Define the product attributes.

TIP To create a product that is not locked to a specific device, set Unlocked from Device to Yes and select an SL-type Locking Type. Defining a product as unlocked from a device is permanent and cannot be reverted after the product is marked as Completed.

4. (Optional) Associate one or more features with the product and configure their license models. If you do not set a license model, the default license model is applied automatically.

NOTE If you are creating a product that is set as Unlocked from Device, the Execution Count and Time from License Generation license models are not relevant and are, therefore, not available in the list.

5.(Optional) Click the Associated Memory Files bar to expand the pane. Then associate and configure one or more memory files.

6.Click Save. The Add Product page closes, and the product is added to the Products list as a draft product.

7.In the Actions column for the product you just created, click the Complete button to enable the product to be added to an entitlement. For other actions, see Actions for Products. For details on creating entitlements, see Entitlements.

Product Attributes

The following table explains the product attributes:

Attribute	Description	Required/Optional	Valid Values
Namespace (Visible only if more than one namespace is available.)	The namespace (also known as batch code) that represents your company's unique vendor code.	Required	Any relevant namespace in the list
Name	Name of the product.	Required	>Maximum: 50 characters >Cannot contain: < > >Must be unique across Sentinel EMS
Identifier	Numeric identifier for the product. NOTE Although it is technically possible to apply the same Product Identifier to multiple products, Thales recommends that you use a unique identifier for every product.	Required	>Integer from 2-65471 >Can be one of the following: •An automatically generated, sequential product identifier. •Your own numeric identifier, if you want to maintain consistency with existing product data, for example.
Provisioning	When set to Yes, enables Sentinel EMS to initiate provisioning requests for the product. When you apply provisioning, you must associate a provisioning method and plan with the product. For more information, see Provisioning.	Optional	Yes OR No Default: No
Description	Additional information about the product. For example, you may want to highlight product features, differentiate between similar products, and so on.	Optional	Maximum: 500 characters
Additional Attributes
External ID	External reference identifier that uniquely identifies the product user in an external system.	Optional	>Maximum: 60 characters >Must be unique
Ref ID 1	Reference identifier that identifies the product in an external system.	Optional	Maximum: 100 characters
Ref ID 2	Reference identifier that identifies the product in an external system.	Optional	Maximum: 100 characters
Unlocked from Device	A product that is distributed with a license that is not locked to a specific device and can therefore be installed freely by any user on any device. Typical uses include: >Trial licenses (free for up to 90 days), which can start from the date of license generation or first use, depending on the License Model. (The Execution Count license model is not relevant for products that are not locked to a device.) >"Unlimited" products that may or may not have licensing restrictions. For example, you might apply a Perpetual license, you may decide to limit the time period, you may use a different mechanism to license the application, or you may decide not to impose any licensing restrictions at all. For more details, see the section on unlocked products in the Sentinel LDK Software Protection and Licensing Guide. Note: Defining a product as unlocked from a device is permanent and cannot be reverted after the product is marked as Completed.	Required	Yes or No
Locking Type	The level of protection for a product according to the type of Sentinel protection key supplied with the product. You set the locking type when defining a product. Locking types can be hardware-based (Sentinel HL keys) or software-based (Sentinel SL keys). When using the Cloud Licensing service (CL keys), you must select one of the SL AdminMode options, such as the default HL or SL AdminMode or SL UserMode option. For more information, see the section on choosing the protection level for your products in the Sentinel LDK Software Protection and Licensing Guide.	Required	>HL. Use for burning licenses on physical, Sentinel HL keys (dongles). >SL AdminMode. Use for activating licenses on Sentinel SL AdminMode keys (software). •Requires the installation of Sentinel Run-time Environment (RTE). •Supports all license terms, including concurrency and detachable licenses. •Provides a high level of compatibility with future operating system updates. >SL UserMode. Use for activating licenses on Sentinel SL UserMode keys (software). •Does not require the installation of Sentinel Run-time Environment (RTE). •Provides limited security for products that are not locked to a device than SL Admin mode. •Provides the highest level of compatibility with future operating system updates. >HL or SL AdminMode. Use with either Sentinel HL keys or Sentinel SL AdminMode keys. >HL or SL AdminMode or SL UserMode. (Default) Use this locking type if the decision on which type of Sentinel protection key is to be shipped with the product is made when each order is processed. For more details, see Sentinel LDK Software Protection and Licensing Guide .
Upgrade To Driverless	Relevant for: HL locking type Enables you to upgrade any Sentinel HL (HASP configuration) keys in the field to Sentinel HL (Driverless configuration) keys. Advantages over Sentinel HL (HASP configuration) keys: >On Microsoft Windows: • Uses HID drivers, which are an integral part of the Windows operating system. Customers can often use these keys without installing any additional support software. •Does not require the Run-time Environment to protect an application. >Supports a higher number of features. >Provides larger on-key memory space.	Required	Yes or No
Use Virtual Clock	Lets you manage time-based licenses for Sentinel HL (Driverless Configuration) keys using a virtual clock when no real-time clock is available. NOTE For Sentinel SL keys, the virtual clock is always available and does not require configuration. How does Virtual Clock work? The expiration period or date for a time-based license is initially calculated according to the system clock of the end user's machine. Sentinel License Manager reads the system time at startup (by default, part of the machine startup) and then uses its internal running time to calculate the time. When an application that is protected with Virtual Clock runs for the first time, Sentinel License Manager queries its internal clock to determine the start time of the software’s license duration. >If the license duration is a fixed period (for example, 30 days or 1 year), Sentinel License Manager calculates the actual date on which the license must stop working and stores this information in the secure storage area of the Sentinel key. The secure storage for a Sentinel SL key is on the hard drive of the end user's computer. The secure storage for a Sentinel HL key is in the HL key. >If the license is set to expire on a specific date, Sentinel License Manager records that date. The expiration time is determined using the formula: [current Sentinel License Manager time] + [number of seconds to expiration] For more information, see the Sentinel LDK Software Protection and Licensing Guide.	Required	Yes or No
Rehost (Visible only if an SL Locking Type is selected)	Relevant for: Any SL locking type Allows the end user to transfer a Sentinel SL protection key from one computer to another. The rehosting process is performed entirely by the end user, with no interaction from the vendor. If no product is set to Disable, but one or more products are set to Enable, then rehosting is enabled for the Sentinel protection key.	Required	One of the following: >Enable. Enables rehosting for the product. >Disable. (Default) Disables rehosting for the product. >Leave As Is. Uses the existing rehosting value that is defined in the Sentinel protection key. >Define in Entitlement. Uses the rehosting value specified when generating the entitlement.
Clone Protection (Physical Machine)	Relevant for: Sentinel SL keys The clone protection scheme to protect against the cloning of physical machines. About Device Cloning Device cloning is one method for enabling the unauthorized use of licensed software. Device cloning involves creating an image of one device (including your software and its legitimate license) and copying this image to other devices. This allows multiple instances of the software even though only a single license was purchased. Sentinel LDK automatically detects probable cloning and disables protected software that is locked to Sentinel SL keys. Clone detection is effective whether the protected software is installed on a physical device or on a virtual machine.	Required	One of the following: >Platform Default: The default clone protection scheme used for all products created in Sentinel EMS. When a product license is installed on an end user's machine, Sentinel LDK automatically selects the most appropriate clone protection for the type of operating system and the environment. >A custom clone protection scheme for physical machines defined using Sentinel EMS REST API. >The clone protection scheme defined in Sentinel LDK-EMS, if the completed product was migrated from Sentinel LDK.
Clone Protection (Virtual Machine)	Relevant for: Sentinel SL keys The clone protection scheme to protect against the cloning of virtual machines. About Device Cloning Device cloning is one method for enabling the unauthorized use of licensed software. Device cloning involves creating an image of one device (including your software and its legitimate license) and copying this image to other devices. This allows multiple instances of the software even though only a single license was purchased. Sentinel LDK automatically detects probable cloning and disables protected software that is locked to Sentinel SL keys. Clone detection is effective whether the protected software is installed on a physical device or on a virtual machine.	Required	One of the following: >Platform Default: The default clone protection scheme used for all products created in Sentinel EMS. When a product license is installed on an end user's machine, Sentinel LDK automatically selects the most appropriate clone protection for the type of operating system and the environment. >A custom clone protection scheme for virtual machines defined using Sentinel EMS REST API. >The clone protection scheme defined in Sentinel LDK-EMS, if the completed product was migrated from Sentinel LDK.

Associate Features

In the Associate Features pane, you can associate features with products and view the list of associated features.

Feature Association Attributes

Attribute	Description	Values
(Check box)	Use to select one or more features if you want to open the Configure License Model dialog box. When you select at least one check box, the Configure License Model button is enabled. You can select the Feature Name check box to configure the license model for all features simultaneously.	(Selected or Cleared)
Feature Name	The name of the feature.	(Read-only)
Default Value	Specifies if an associated feature will be included in or excluded from 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.	One of the following: >Mandatory: Prevents the order taker from excluding the feature while generating entitlements. >Included (Optional): The feature will be listed by default while generating an entitlement for the product but can be excluded. >Excluded (Optional): The feature will NOT be listed by default, but the order taker can include the feature.
Default License Model	The default license model for the associated feature.	You can leave the default license model as is or click one of the Configure License Model buttons to select another license model.
Apply License	Specifies how to apply the license model attributes to the feature. Only one license model may be associated with a feature. 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.	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. Learn more How does it work? During the activation for license updates, Sentinel EMS verifies that the number of concurrent instances matches the original license and then updates the license as follows according to the license model: >Execution Count license model. Adds the number of executions to the current number of executions. >Expiration Date license model. Overwrites the end date. >Perpetual license model. Not relevant because there are no license terms to change. >Time from First Use license model. Resets the expiration date based on the number of days specified in the update. The new expiration date is set when the user accesses the vendor's application for the first time after the update is applied. To prevent the loss of any remaining days prior to the update, Thales recommends that users apply the update when the license expires and not before. >Time from License Generation license model. Adds the number of days to the end date. If the license update includes newly added products, or if the Remove licenses from keys before applying updates check box is selected, Sentinel EMS handles the activation as it would for the Add option. Important. Activation for the license update fails in the following cases: >The license update is associated with the Perpetual license model. >The license update includes changes to the number of concurrent instances. >The activation fails for at least one product when activating a license update for multiple products simultaneously. >The license update does not include any changes to the license terms. >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 expiration date, you must explicitly set the same expiration date. •To retain the current value for the number of days, execution count, and concurrent instances, set the relevant values to 0. This instructs Sentinel EMS not to add anything to those values. Learn more The following examples show how you can might enable or prevent the "add" mechanism from changing the license terms or concurrent instances during a license update. Example—Execution Count license model: Suppose you need to add 10 executions to a license that currently includes 20 executions, but do not want to change the 10 concurrent instances that are already specified in the existing license. To do this, change the number of executions to 10 and change the number of concurrent instances to 0. When you activate the updated entitlement and apply the changes, the execution count will change to 30—20 from the pre-existing license, and 10 that are added to the updated license because of the "add" mechanism. The number of concurrent instances will remain 10 because 0 concurrent instances are added. Example—Expiration Date license model: Suppose you need to extend a license for another year, but do not want to change the 10 concurrent instances that are already specified in the existing license. When you activate the updated entitlement and apply the changes, the expiration date will reflect your change, but, unless you set the concurrent instances to 0, an additional 10 concurrent instances will be added to the license for a total of 20 concurrent instances—10 from the pre-existing license, and 10 that are added to the updated license because of the "add" mechanism. To prevent the change to concurrent instances, set the value to 0. Example—Perpetual license model: Suppose you need to add 5 concurrent instances to an existing license. If the existing license has 10 concurrent instances, and you specify 5 in the license model, then a total of 15 concurrent instances will be available in the updated license. Example—Time from First Use license model: Suppose you need to extend a license that has 10 concurrent instances for another 30 days, and you also want to add 5 additional concurrent instances. To do this, set the concurrent instances to 5 and set the number of days to 30. After the license update is applied, and the user subsequently accesses the vendor's application: >An additional 5 concurrent instances are added to the license for a total of 15 concurrent instances—10 from the pre-existing license, and 5 that are added to the updated license because of the "add" mechanism. >The new expiration date is set to 30 days from the date when the user accesses the vendor's application for the first time after the license update is applied. To ensure that the user does not lose days from the original license, make sure that the license update is applied only when the license expires and not before. For example, if the license update is applied on day 25 of a 30-day license, the license update takes effect as soon as the user accesses the application, so the user may potentially lose the last five days of the original license. For ease of use, if you want to retain the concurrency values and change only the license terms (expiration date, number of days, or execution count), consider selecting System-specified or Overwrite instead. Example—Time from License Generation license model: Suppose you need to extend a license that has 10 concurrent instances for another 30 days, and you also want to add 5 additional concurrent instances. Set the number of days to 30 and set the concurrent instances to 5. When you activate the updated entitlement and apply the changes, the end date will change as expected, and an additional 5 concurrent instances will be added to the license for a total of 15 concurrent instances—10 from the pre-existing license, and 5 that are added to the updated license because of the "add" mechanism. For ease of use, if you want to retain the concurrency values and change only the license terms (expiration date, number of days, or execution count), consider selecting System-specified or Overwrite instead. >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. Learn more The following example describes the Execution Count license, but the "overwrite" mechanism is the same for all license models. To modify license model attributes, you update the values as needed. Example: Suppose you need to add 30 executions to an Execution Count license, and also want to add 5 concurrent instances to the 10 concurrent instances currently specified in the license. To update this license, you set the new execution count by totaling the remaining executions plus 30, and you set the number of concurrent instances to 15—10 from the pre-existing license plus 5 that you are adding to the updated license. Conversely, if you need to change only the number of executions or only the number of concurrent instances, you would change only the required value and leave the other value as is.
Configure License Model	Buttons used to open the Configure License Model dialog box. Enables you to associate and configure a license model for a feature. A feature can be associated with one license model. To start configuring a license model, do one of the following: >In the Associated Features pane, select the check box for one or more features and click the Configure License Model button. Note: If you select multiple features, they must all be associated with the same license model. >In the Actions column, click the Configure License Model button for the specified feature.	The available attributes depend on the selected license model. For details, see Sentinel LDK Enforcement - License Models.
Actions > Delete	Removes the associated feature from the product.	N/A

Associate Memory Files

In the Associate Memory pane, you can associate available memory files with products and view the list of associated memory files. For details on creating memory files, see Memory.

You can apply:

Memory File Type	Supported Sentinel Keys
Custom-Defined	>Sentinel SL AdminMode keys >Sentinel SL UserMode keys >Sentinel HL (Driverless configuration) keys (excluding Sentinel HL Basic keys)
Default	>Sentinel SL AdminMode keys >Sentinel SL UserMode keys >Sentinel HL (Driverless configuration) keys (excluding Sentinel HL Basic keys) >Sentinel HL (HASP configuration) keys (excluding Sentinel HL Basic keys)

Memory File Type

Supported Sentinel Keys

Custom-Defined

>Sentinel SL AdminMode keys

>Sentinel SL UserMode keys

>Sentinel HL (Driverless configuration) keys (excluding Sentinel HL Basic keys)

Default

>Sentinel SL AdminMode keys

>Sentinel SL UserMode keys

>Sentinel HL (Driverless configuration) keys (excluding Sentinel HL Basic keys)

>Sentinel HL (HASP configuration) keys (excluding Sentinel HL Basic keys)

Memory Association Attributes

NOTE The combined value of Text and Offset must not exceed the memory file Size (Bytes).

Attribute	Description	Required/Optional	Valid Values
File Name	A descriptive name of the memory file.	Required	(Read-Only)
File ID	Integer that identifies the memory file and is used by your application to refer to that file.	Required	(Read-Only)
File Type	Type of data stored in the memory file.	Required	(Read-Only)
Offset	The hexadecimal starting point of the memory file.	Optional	Default: 0
Size (Bytes)	Size of the memory file in bytes. For user-created memory files, the size is automatically determined based on the text length and offset.	Optional Although this attribute is optional, you must set either the memory file size or text value (or both).	Maximum: 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* * Sentinel HL Pro keys provide 112 bytes each of Read/Write and Read-Only memory. For the latest information, see Sentinel Keys Data Sheet.
Text Allow Overwrite	The memory data in text format. You can add or edit text if needed. To enable the value to be changed when creating an entitlement, select the Allow Overwrite check box.	Optional Although this attribute is optional, you must set either the memory file size or text value (or both).	Maximum: 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* * Sentinel HL Pro keys provide 112 bytes each of Read/Write and Read-Only memory. For the latest information, see Sentinel Keys Data Sheet.
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. To modify a deployed, default memory file: 1.Select a memory file with the same File ID that is already associated with product's Identifier. 2.Select Add. To modify a deployed, user-created memory file: 1.Select a memory file with the same File ID that is already associated with product's Identifier. NOTE If you plan to replace only some of the text, then, in the memory file on the Memory page, make sure that the Offset and Size (Bytes) are defined to insert the text at the required location. 2.Do one of the following: •To replace all of the text, select Overwrite. •To replace some of the text, select Add. The original text is overwritten only where the offset and size overlap the original settings.	Required	>Add: (Default) Adds the memory file to the product. When modifying a product with the same File ID as an existing memory file, the location where the file text is added depends on the specified offset and size defined in the memory file on the Memory page. •If both memory files have the same offset and size, the existing file is overwritten. •If the memory files have different offset and size settings, and the new values overlap the old values, the file is added, and the original text is overwritten only where the values overlap. •If the memory files have different offset and size settings, and the new values do not overlap the old values, the file is added in addition to the original file. >Overwrite: Replaces the data in the existing memory file (using the same File ID) by overwriting the memory file. (Not available for default memory files) >Delete: Permanently deletes the memory file attached to the specified license. (Not available for default memory files)
Actions > Delete	Removes the associated memory file from the product.	N/A	N/A

Actions for Products

The following table lists the actions available for products:

Action		Description
	Complete	Marks a product as Completed. This finalizes the product and makes the product available for inclusion in an entitlement. Note: >You cannot modify any attribute for a product that is included in an entitlement. >You cannot delete a product that is included in an entitlement.
	Edit	Enables you to update existing product information. For details on editing products, see Editing an Entity. Note: >To perform the following changes, you must first remove all associated entities. For example, if features and/or memory files are associated with the product, you must remove them before you can: •Change the Locking Type value for a draft or completed product. •Change the Unlocked from Device value for a draft product.
	Copy	Duplicates an existing product, enabling you to edit the copy and create a new product. Note: >You can add or remove features from the product and change the settings to allow features to be excluded if required. >To make the product unique, you must change at least the product Name or Product Identifier. >To perform the following changes, you must first remove all associated entities. For example, if features and/or memory files are associated with the product, you must remove them before you can: •Change the Locking Type value for a draft or completed product. •Change the Unlocked from Device value for a draft product. >You can modify or retain other attributes.
	End of Life	Marks a product as End of Life (EOL) to make the product obsolete. Note: >You cannot add an EOL product to entitlements. >You cannot edit or delete a product that is marked EOL. >You can create a copy of an EOL product, modify the copy as needed, and mark it as Complete . This is useful when creating a new version of the same product if you want to ensure that the earlier version cannot be added to an entitlement. >You can restore an EOL product by marking it as Complete . This makes the product available for entitlements.
	Delete	Deletes a draft product. Note: You cannot delete a draft product that is associated with a test entitlement.
	View Downloads	Associates downloads with the product using the Downloads page. To link a download to a product: 1.Select Downloads to open the Downloads page. 2.Follow the steps in Creating a Download to create and associate a download with a product.