Sentinel RMS Enforcement Properties

License File Name Configuration

Field Description

License File Name Format

Field	Description
License File Name Format	The naming pattern to be used when generating a license certificate file. You can use static text, or a dynamic expression using the supported parameters listed below, or a combination of both. When a license file is generated, Sentinel EMS evaluates the expression based on the License File Name Format value, and replaces any parameters with actual data. Example: Suppose you want to configure the license file name format to include your company's name (static text), the product name and activation date and time (dynamic expressions), and the .txt suffix, using hyphens as delimiters. In this scenario, If your company's name is Papyrus, and the product is named TextEditor, you would enter: `Papyrus-{product.name}-{timeStamp}.txt` If you generated the license on March 3, 2024 just before 11:00 AM UTC, the license file might be named: Papyrus-TextEditor-2024-03-28 10_59_52.txt If a value is not defined for a specific parameter, then Sentinel EMS skips that value. For example, if the license file name format is defined as `{customer.name}-{entitlement.refId1}`, but for a specific entitlement, no reference ID was defined, then the generated file name would include only the customer name followed by a hyphen, which is the delimiter. In this case, if the company name is Papyrus, then the generated file name would be Papyrus-. Similarly, if a value includes an unsupported character, then Sentinel EMS replaces that character with an underscore. For example, suppose that the value for `{entitlement.refId1}` includes a slash (/). In this case the slash would be replaced with an underscore (_). If the value for `{entitlement.refId1}` is evaluated as ABC/123, then the generated license file name would be ABC_123. Although you are setting the license file name format at the global level for all license file certificates, the format can be overwritten for a specific license model at the license model level if the option is available. For details, see Copying a License Model. Default value: lservrc To customize the license file name format: 1.Enter the required file name format. •Static text. (Optional) Specify a file name that does not change. You can also combine static text with one or more parameters. •Supported parameters. (Optional) Specify one or more of the following parameters in any order. Make sure to include the curly brackets. –Product • `{product.descr}`Product description • `{product.externalId}` • `{product.family}` • `{product.name}` –Feature • `{feature.descr}`Feature description • `{feature.externalId}` • `{feature.name}` –License Model • `{licensemodel.name}` –Entitlement • `{entitlement.customerName}` • `{entitlement.eid}` • `{entitlement.refId1}` • `{entitlement.refId2}` –Activation • `{activation.aid}` • `{activation.externalId}` • `{activationAttribute.}`You can use any activation attribute including license model attributes.* –TImestamp • `{timeStamp}`Generates the time stamp in UTC format, for example, 2024-03-28 10_59_52 •Custom attributes. (Optional) You can include any of the custom attributes that exist for entitlements and activations, for example, `entitlementcustomattribute.UNIT_NAME` or `activationcustomattribute.UNIT_NAME`. •Delimiters. (Optional) Separate the parameters using a delimiter, such as a hyphen (-) or underscore (_). •Spaces. Do not include spaces. •Unsupported characters. The following special characters are not supported: \ / : * ? " < > \| •Reserved characters. Do not use attribute names from other enforcements, even if those enforcements are not available in your Sentinel EMS portal. For details, see the section on special and reserved enforcement attributes in Sentinel EMS REST API Guide. •Maximum length. Make sure that the generated file name does not exceed the maximum character length: –Complete file name: 215 characters including all parameter values, any delimiters, and the file extension –Each parameter: 50 characters If the generated file name exceeds the maximum length, the excess is truncated from the end. •File name extension. (Optional) A file extension, for example: `.txt` 2.Validate the file format. a.Create a test entitlement and activate a product. b.Download the resulting license file and make sure that the file name matches your expectations.

The naming pattern to be used when generating a license certificate file.

You can use static text, or a dynamic expression using the supported parameters listed below, or a combination of both. When a license file is generated, Sentinel EMS evaluates the expression based on the License File Name Format value, and replaces any parameters with actual data.

Example: Suppose you want to configure the license file name format to include your company's name (static text), the product name and activation date and time (dynamic expressions), and the .txt suffix, using hyphens as delimiters. In this scenario, If your company's name is Papyrus, and the product is named TextEditor, you would enter:

Papyrus-{product.name}-{timeStamp}.txt

If you generated the license on March 3, 2024 just before 11:00 AM UTC, the license file might be named:

Papyrus-TextEditor-2024-03-28 10_59_52.txt

If a value is not defined for a specific parameter, then Sentinel EMS skips that value. For example, if the license file name format is defined as {customer.name}-{entitlement.refId1}, but for a specific entitlement, no reference ID was defined, then the generated file name would include only the customer name followed by a hyphen, which is the delimiter. In this case, if the company name is Papyrus, then the generated file name would be Papyrus-.

Similarly, if a value includes an unsupported character, then Sentinel EMS replaces that character with an underscore. For example, suppose that the value for {entitlement.refId1} includes a slash (/). In this case the slash would be replaced with an underscore (_). If the value for {entitlement.refId1} is evaluated as ABC/123, then the generated license file name would be ABC_123.

Although you are setting the license file name format at the global level for all license file certificates, the format can be overwritten for a specific license model at the license model level if the option is available. For details, see Copying a License Model.

Default value: lservrc

To customize the license file name format:

1.Enter the required file name format.

•Static text. (Optional) Specify a file name that does not change. You can also combine static text with one or more parameters.

•Supported parameters. (Optional) Specify one or more of the following parameters in any order. Make sure to include the curly brackets.

–Product

• {product.descr}Product description

• {product.externalId}

• {product.family}

• {product.name}

–Feature

• {feature.descr}Feature description

• {feature.externalId}

• {feature.name}

–License Model

• {licensemodel.name}

–Entitlement

• {entitlement.customerName}

• {entitlement.eid}

• {entitlement.refId1}

• {entitlement.refId2}

–Activation

• {activation.aid}

• {activation.externalId}

• {activationAttribute.*}You can use any activation attribute including license model attributes.

–TImestamp

• {timeStamp}Generates the time stamp in UTC format, for example, 2024-03-28 10_59_52

•Custom attributes. (Optional) You can include any of the custom attributes that exist for entitlements and activations, for example, entitlementcustomattribute.UNIT_NAME or activationcustomattribute.UNIT_NAME.

•Delimiters. (Optional) Separate the parameters using a delimiter, such as a hyphen (-) or underscore (_).

•Spaces. Do not include spaces.

•Unsupported characters. The following special characters are not supported: \ / : * ? " < > |

•Reserved characters. Do not use attribute names from other enforcements, even if those enforcements are not available in your Sentinel EMS portal. For details, see the section on special and reserved enforcement attributes in Sentinel EMS REST API Guide.

•Maximum length. Make sure that the generated file name does not exceed the maximum character length:

–Complete file name: 215 characters including all parameter values, any delimiters, and the file extension

–Each parameter: 50 characters

If the generated file name exceeds the maximum length, the excess is truncated from the end.

•File name extension. (Optional) A file extension, for example: .txt

2.Validate the file format.

a.Create a test entitlement and activate a product.

b.Download the resulting license file and make sure that the file name matches your expectations.

General Configuration

Field	Description
Fingerprint for On-premises Licenses	Determines whether using fingerprints as a locking mechanism will be the standard flow for on-premises licenses. Default value: >Yes for Sentinel EMS version 5.3 and later. >No for all earlier versions of Sentinel EMS 5.3. This is to maintain backward compatibility. NOTE >It is recommended not to enable Fingerprint for On-premises Licenses if device locking is enabled. > The fingerprint locking mechanism is supported for Sentinel RMS license version 16 and above.
Include EID to key (EID size must be less than 46 characters)	The license string for licenses generated from Sentinel EMS or Sentinel Cloud Connect will include the encrypted EID. The maximum character limit of EID, pushed with the license string is 45 characters. Default value: Yes
User Limit Configuration	This property regulates the usage of the component multiplier and the license model user limit. This section provides a summary of the rules for calculating the user limit when Multiplier and Quantity values are also specified. Calculating the User Limit illustrates the rules with examples: > If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is also set to 'No', then the user limit is equal to quantity, and the license model user limit is ignored. This case is valid for all types of activation methods (rows # 4, 8, and 15 in the table below depict this behavior), but in the case of the 'Fixed' activation method, it is valid only if the fixed quantity is greater than 1 (row # 15 in the table below depicts the case of quantity equal to 5). > If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is also set to 'No' and the activation method is 'Fixed' with fixed quantity as 1, then the calculated user limit is equal to the user limit defined in the license model. Note that this case is an exception and is valid only for the Fixed activation method (row # 16 in the table below depicts this). > If the User Limit Configuration property is set to 'Yes' and Component Multiplier Visible is set to 'No', then the quantity will be multiplied by the user limit given in the license model (rows # 2, 6, 11, and 12 in the table below depict this). > If the User Limit Configuration property is set to 'Yes' and Component Multiplier Visible is set to 'Yes', then quantity will be multiplied with the user limit and component multiplier value set in the license model (rows # 1, 5, 9, and 10 in the table below depict this). > If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is set to 'Yes', then the user limit is equal to quantity. The license model user limit value is ignored. The component multiplier is ignored as well as it works only if User Limit Configuration is set to 'Yes' (rows # 3, 7, and 13 in the table below depict this).

Field

Description

Fingerprint for On-premises Licenses

Determines whether using fingerprints as a locking mechanism will be the standard flow for on-premises licenses.

Default value:

>Yes for Sentinel EMS version 5.3 and later.

>No for all earlier versions of Sentinel EMS 5.3. This is to maintain backward compatibility.

NOTE

>It is recommended not to enable Fingerprint for On-premises Licenses if device locking is enabled.

> The fingerprint locking mechanism is supported for Sentinel RMS license version 16 and above.

Include EID to key (EID size must be less than 46 characters)

The license string for licenses generated from Sentinel EMS or Sentinel Cloud Connect will include the encrypted EID. The maximum character limit of EID, pushed with the license string is 45 characters.

Default value: Yes

User Limit Configuration

This property regulates the usage of the component multiplier and the license model user limit.

This section provides a summary of the rules for calculating the user limit when Multiplier and Quantity values are also specified. Calculating the User Limit illustrates the rules with examples:

> If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is also set to 'No', then the user limit is equal to quantity, and the license model user limit is ignored. This case is valid for all types of activation methods (rows # 4, 8, and 15 in the table below depict this behavior), but in the case of the 'Fixed' activation method, it is valid only if the fixed quantity is greater than 1 (row # 15 in the table below depicts the case of quantity equal to 5).

> If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is also set to 'No' and the activation method is 'Fixed' with fixed quantity as 1, then the calculated user limit is equal to the user limit defined in the license model. Note that this case is an exception and is valid only for the Fixed activation method (row # 16 in the table below depicts this).

> If the User Limit Configuration property is set to 'Yes' and Component Multiplier Visible is set to 'No', then the quantity will be multiplied by the user limit given in the license model (rows # 2, 6, 11, and 12 in the table below depict this).

> If the User Limit Configuration property is set to 'Yes' and Component Multiplier Visible is set to 'Yes', then quantity will be multiplied with the user limit and component multiplier value set in the license model (rows # 1, 5, 9, and 10 in the table below depict this).

> If the User Limit Configuration property is set to 'No' and Component Multiplier Visible is set to 'Yes', then the user limit is equal to quantity. The license model user limit value is ignored. The component multiplier is ignored as well as it works only if User Limit Configuration is set to 'Yes' (rows # 3, 7, and 13 in the table below depict this).

Calculating the User Limit

The following table illustrates the rules for calculating the user limit with examples:

#	Activation Method	User Limit Configuration (Administration Console)	User Limit (License Model Value)	Component Multiplier Visible (Administration Console)	Multiplier (Value)	Activation Quantity (Value)	Rule For Calculating User Limit	Calculated User Limit
1	Full	Yes	100	Yes	5	10	Calculated User Limit = Quantity * User Limit * Multiplier	101005=5000
2		Yes	100	No	Not enabled	10	Calculated User Limit = Quantity * User Limit	10*100=1000
3		No (Default)	100 (Default)	Yes	Multiplier value does not matter when User Limit is off.	10	Calculated User Limit = Quantity	10
4		No (Default)	100 (Default)	No (Default)	Not enabled	10	Calculated User Limit = Quantity	10
5	Partial	Yes	100	Yes	5	10	Calculated User Limit = Quantity * User Limit * Multiplier	101005=5000
6		Yes	100	No	Not enabled	10	Calculated User Limit = Quantity * User Limit	10*100=1000
7		No (Default)	100 (Default)	Yes	Multiplier value does not matter when User Limit is off.	10	Calculated User Limit = Quantity	10
8		No (Default)	100 (Default)	No	Not enabled	10	Calculated User Limit = Quantity	10
9	Fixed	Yes	100	Yes	5	5	Calculated User Limit = Quantity * User Limit * Multiplier	51005=2500
10		Yes	100	Yes	5	1	Calculated User Limit = Quantity * User Limit * Multiplier	11005=500
11		Yes	100	No	Not enabled	5	Calculated User Limit = Quantity * User Limit	5*100=500
12		Yes	100	No	Not enabled	1	Calculated User Limit = Quantity * User Limit	1*100=100
13		No (Default)	100 (Default)	Yes	Multiplier value does not matter when User Limit is off.	5	Calculated User Limit = Quantity	5
14		No (Default)	100 (Default)	Yes	Multiplier value does not matter when User Limit is off.	1	Exception (For activation method as Fixed and quantity as 1) Calculated User Limit = User Limit	100
15		No (Default)	100 (Default)	No	Not enabled	5	Calculated User Limit = Quantity	5
16		No (Default)	100 (Default)	No	Not enabled	1	Exception (For activation method as Fixed and quantity as 1) Calculated User Limit = User Limit	100

Revocation Configuration

Field	Description
Create End User Revocation Tool Link	Set to 'Yes' to create end user tool links in Sentinel EMS.
Revocation Proof Required (Sentinel RMS)	Set to 'Yes' to specify that the Sentinel RMS revocation proof is required while performing revocation.

Revocation Request Email Configuration

Field	Description
BCC	Send blind carbon copies of the revocation request email to this address. Possible values: One email address
CC	Send carbon copies of the revocation request email to this address. Possible values: One email address
Sender Name	The sender name that appears in the emails.
Sender Email	The revocation request email is from this email address.
Email Required	An email is sent for a revocation request. >DESIRED: Sentinel EMS will try to send the email, but if it fails, the operation will still succeed. >REQUIRED: Sentinel EMS will try to send the email, but if it fails, the operation fails. >NO: Sentinel EMS will not send the email.

NOTE To provide multiple email addresses in CC and BCC fields, use a semicolon (without a space) as a separator.

Revocation Proof Email Configuration

Field	Description
BCC	Send blind carbon copies of the revocation proof received email to this address. Possible values: One email address
CC	Send carbon copies of the revocation proof received email to this address. Possible values: One email address
Sender Name	The sender name that appears in the emails.
Sender Email	The revocation proof received email is from this email address.
Email Required	An email is sent for a revocation proof received. >DESIRED: Sentinel EMS will try to send the email, but if it fails, the operation will still succeed. >REQUIRED: Sentinel EMS will try to send the email, but if it fails, the operation fails. >NO: Sentinel EMS will not send the email.

NOTE To provide multiple emails in CC and BCC fields, use a semicolon (without space) as separator.

Revocation Proof Confirmation Email Configuration

Field	Description
BCC	Send blind carbon copies of the revocation request confirmation email to this address. Possible values: One email address
CC	Send carbon copies of the revocation request confirmation email to this address. Possible values: One email address
Sender Name	The sender name that appears in the emails.
Sender Email	The revocation request confirmation email is from this address.
Email Required	An email is sent for revocation request confirmation.

NOTE To provide multiple emails in CC and BCC fields, use a semicolon (without space) as separator.

Revocation Proof Rejection Email Configuration

Field	Description
BCC	Send blind carbon copies of the revocation rejection email to this address. Possible values: One email address
CC	Send carbon copies of the revocation rejection email to this address. Possible values: One email address
Sender Name	The sender name that appears in the emails.
Sender Email	The revocation request rejection email is from this email.
Email Required	An email is sent for a revocation request rejection. >DESIRED: Sentinel EMS will try to send the email, but if it fails, the operation will still succeed. >REQUIRED: Sentinel EMS will try to send the email, but if it fails, the operation fails. >NO: Sentinel EMS will not send the email.

NOTE To provide multiple emails in CC and BCC fields, use a semicolon (without space) as separator.

Activation Configuration

Field	Description
Set Start and End Dates on First Activation	(Applicable only when the Start From Activation Date attribute in the License Duration attribute group in a license model is set to 'Yes') Set to 'Yes' to instruct Sentinel EMS to set the start and end dates for a specific feature when the license is activated for the first time. The start date will automatically be set as the date of the first activation, and the end date will be calculated based on the License Duration (days) value starting from the first activation date. This ensures that the license is available for a specific period of time starting from the moment that the license is activated for the first time. Example: Suppose you want to be able to provide access to premium content for one week. If you set this option to 'Yes', and, in an entitlement, the Start From Activation Date attribute in the license model is set to 'Yes', and the License Duration (days) value is set to '7', then the license start date would automatically be set at the first activation, and the end date would be calculated as seven days later. This means that users will have access to the premium content for exactly one week from the moment they first activate the license.
RMS Substitution Key Value Pair	This property is used for replacing unsupported characters in the evaluated output of a dynamic expression. Format: 'special char1':'new replacement char','special char2':'new replacement char' For more information on dynamic expressions, see Dynamic Substitution of License Model Attributes .

Field

Description

Set Start and End Dates on First Activation

(Applicable only when the Start From Activation Date attribute in the License Duration attribute group in a license model is set to 'Yes')

Set to 'Yes' to instruct Sentinel EMS to set the start and end dates for a specific feature when the license is activated for the first time. The start date will automatically be set as the date of the first activation, and the end date will be calculated based on the License Duration (days) value starting from the first activation date. This ensures that the license is available for a specific period of time starting from the moment that the license is activated for the first time.

Example: Suppose you want to be able to provide access to premium content for one week. If you set this option to 'Yes', and, in an entitlement, the Start From Activation Date attribute in the license model is set to 'Yes', and the License Duration (days) value is set to '7', then the license start date would automatically be set at the first activation, and the end date would be calculated as seven days later. This means that users will have access to the premium content for exactly one week from the moment they first activate the license.

RMS Substitution Key Value Pair

This property is used for replacing unsupported characters in the evaluated output of a dynamic expression.

Format: 'special char1':'new replacement char','special char2':'new replacement char'

For more information on dynamic expressions, see Dynamic Substitution of License Model Attributes .

Action Buttons

The following action buttons are available at the bottom of the page.

Button	Description
Test Email	Send test emails to specified email address. This works only if the SMTP details are provided and are valid.
Save	Save the data entered.