Common Enforcement Properties

Specifies if SOCKS proxy is used. Socket Secure (SOCKS) is an Internet protocol that establishes a connection between the client and server and then routes all traffic back and forth using a proxy server.

Possible values: Yes or No

Specifies if SMTP authentication is used.

Possible values: Yes or No

NOTE   Sentinel EMS supports only basic SMTP authentication.

Specifies if transport layer security (TLS) is used.

TLS is a way of changing data such as your user name and password into code as it travels across the internet, so that the data will be secure and private. With email delivery, TLS begins with an unsecured connection to the email servers, and then upgrades to a secure connection when the information is sent.

Possible values: Yes or No

Default value: No

The email address from which all emails are sent.

The port that connects to the email exchange server.

Default value: 25

Specifies if the entitlement certificate is sent to defined channel partners.

Possible values: Yes or No

Specifies if the CC Email field can be edited while creating, editing, modifying, splitting, and transferring entitlements.

Possible values: Yes or No

The email address to which carbon copies of the entitlement certificate are sent. You can type the email address manually or select it from the autocomplete list. Press Enter after each manually-entered email address.

Possible values: Up to 15 email addresses

The email address to which blind carbon copies of the entitlement certificate are sent. You can type the email address manually or select it from the autocomplete list. Press Enter after each manually-entered email address.

Possible values: Up to 15 email addresses

Specifies if license certificate email attachments should be compressed.

Possible values:

>Yes—Attachments are compressed into a .zip file.

>No—Attachments are sent as plain files.

Default value: Yes

Specifies if emails should include download links.

Possible values:

>Yes—Emails include links to the download files associated with the products in the entitlement.

>No—Download links are not included in emails.

The email address to which a blind carbon copy of the email is sent.

Possible values: One email address

The email address to which a carbon copy of the email is sent.

Possible values: One email address

The email address to which a blind carbon copy of the email is sent.

Possible values: One email address

The email address to which a carbon copy of the email is sent.

Possible values: One email address

Support email address.

Specifies that all products in an entitlement are activated at the same time.

This setting can be modified for specific entitlements as needed. For enforcement- and license model-specific restrictions for a particular entitlement, see Entitlement as a Whole.

Possible values: Yes or No

Default Value: No

Specifies the type of user that can activate an entitlement. Activation refers to any type of activation, including burning a key and produce and push.

This setting can be modified for specific entitlements as needed. For details, see Allow Activation ... By.

Possible values:

>All Users: 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.

Default Value: All Users

Specifies if licenses for all line items are consolidated into a single file on activation.

Possible values: Yes or No

Default Value: Yes

Possible values:

>Yes—A customized entitlement ID (EID) and product key ID can be specified while creating an entitlement.

>No—Sentinel EMS automatically generates the EID and PKID.

Default Value: No

NOTE   Customized EID and PKID cannot contain spaces.

Specifies if the HTTPS protocol is used.

Possible values: Yes or No

Sets the market group as "Default" for REST API calls.

When multiple market groups exist in Sentinel EMS, this property is used to control the value of the market group when it is not passed as a parameter in the REST API calls.

Set the value of this property to "Yes" to use the "Default" market group as the value if the market group parameter is not provided.

If you set the value to of the property to "No", then an error is generated during customer, user, and entitlement creation if the market group parameter is not provided.

Default value: Yes

NOTE   If a new namespace is added when there are multiple market groups in the system, then the namespace should be associated to a relevant market group before its products can be used in an entitlement.

Specifies if line items from multiple entitlements can be selected for simultaneous activation.

Possible values: Yes or No

NOTE   Not supported for the Sentinel LDK enforcement. If the Sentinel LDK enforcement is available in your Sentinel EMS instance—with or without other enforcements, set the value to No.

Sets the default login type on the Sentinel EMS customer portal.

When more than one login type is available, the login types are displayed as tabs on the login screen, and the default login type (defined in this attribute) is automatically selected. Otherwise, if the Show Only Default Customer Portal Login Type attribute is set to "Yes", then only the default login type is available, and the tabbed view displaying login types is not shown.

Possible values:

>Email—Enables customers to use the Email option to log in with their credentials (email address and password).

>EID—Enables customers to use the EID option to log in with an entitlement ID (EID).

>PKID—Enables customers to use the PKID option to log in with the product key (PKID).

Default value: Email

When set to "Yes", only the Default Customer Portal Login Type is available when logging on to the Sentinel EMS customer portal.

NOTE    This attribute value controls login access to the customer portal for both the UI and the API.

Possible values: 

>Yes—Only the default login type is available. The tabbed view displaying login types is not shown.

>No—The tabbed view displaying login types is shown, and people can log in to the customer portal using any of the available login options.

Default value: No

The maximum value that is accepted by the component multiplier.

The product description is displayed together with the product name during activation.

The number of unsuccessful login attempts that can be performed before Sentinel EMS locks the account.

Value range: 3 to 999

Default value: 10—The account is locked on the 11th incorrect login attempt.

When using the Sentinel EMS REST API, this property specifies if a channel partner can view and/or add customers and users in an entitlement during split or transfer.

Possible values:

>None—The channel partner cannot view or create customers and users.

>View Customers and Users—The channel partner can view customers and users but cannot create them. (Only GET is supported.)

>Create Customers and Users—The channel partner can create customers and users but cannot search for them. (Only POST, PUT and PATCH are supported.)

>All—The channel partner can view and create customers and users. (Only GET, POST, PUT and PATCH are supported.)

Default value: None

This property can be used to provide a regular expression for an email validation. This property helps a software vendor customize the email validation as per their requirement.

Default Value: [a-zA-Z0-9!#$%&'*+/=?^_`

{|}~-](?:.[a-zA-Z0-9!#$%&'*/=?^_`{|}

~-])@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-][a-zA-Z0-9])?.)[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?

Specifies if the Multiplier attribute is visible and available to a user with administrative privileges who is creating or updating a product.

Possible values: Yes or No

Default value: No

Specifies if vendor users must enter feedback comments when performing transactions, such as entitlement creation or activation.

NOTE   To maintain backward compatibility, in Sentinel EMS version 4.2 and later, this property controls the behavior of comments that are added by vendor users to entitlements and activations. In Sentinel EMS versions 4.1 and earlier, there is no change in behavior in the comments added by a vendor user.

Possible values:

>DESIRED

>REQUIRED

This property is visible only when you upgrade Sentinel EMS to version 5.3.200 or later. The customer portal used in versions earlier than 5.3.200 is referred to as the legacy customer portal. For fresh or non-upgrade cases (version 5.3.200 or later), this property is not visible.

The Use Legacy Customer Portal property is used in combination with the Customer Portal URL property to determine which customer portal URL to publish in email notifications sent to customers and users.

Possible Values:

Yes— Keeps the legacy behavior. Email notifications include the customer portal URL that was available to customers and users before upgrading to Sentinel EMS 5.3.200 or later.

No— Email notifications include the latest customer portal's default URL or the URL configured in the Customer Portal URL property.

Default value: Yes

NOTE   Not relevant for Sentinel LDK.

The URL of the customer portal that is published in email notifications for customers and users (such as, the entitlement certificate email). You can use this property to specify the URL of your own customer portal (overriding the default customer portal URL).

Specifies if the functionality in the Associated Downloads pane for download management in the Sentinel EMS portal is enabled.

Possible values: Yes or No

Default value: Yes

The maximum number of concurrent requests allowed from an IP address to each URL in the Sentinel EMS portal. You can configure this property to a suitable number to keep your portal safe from denial-of-service (DoS) attacks.

Default value: 100

The default Enforcement Type value displayed in a drop-down list when more than one enforcement is available. The Enforcement Type list is available in:

>The License Models page (Catalog > License Models).

>The Associate License Models section, which is located in the Add Feature page. You can access this page by clicking the Add Feature button while creating a feature from the Features page, or while creating a product from the Products page.

Possible values:

>If multiple enforcements are available, you can select the required enforcement from the list.

>If only one enforcement is available, then the value is displayed as read-only.

This property is for third-party enforcements. When set to Yes, The Revoke Immediately action on the Sentinel EMS user interface acts as a custom revoke, ensuring that Sentinel EMS sends the activation ID to the license generator for forced revocations.

To configure forced revocations for third-party enforcements using this property, you can connect to Thales Professional Services.

This property appears disabled by default.

Default value: No

This property appears only when the 'Call License Generator On Revoke' property is enabled. If this property is set to "Yes" then Sentinel EMS asks for a deactivation code Revoke Immediately is initiated.

Default value: No

If you select this option, then after the revocation receipt is uploaded, all revocations are automatically confirmed. The software vendor does not need to manually confirm or reject the revocation.

Default value: Yes

The priority of a thread. It can be an integer between 1 and 10.

Default value: 4

The number of threads available for concurrent execution of jobs.

Default value: 5

The maximum number of entitlements that can be created in a batch. It cannot exceed 5000.

Default value: 1000

The period in milliseconds after which manual recovery takes place.

Default value: 300000

Number of days added to the user login start date to calculate the default user login expiration date. This date is used during user login creation if the user login expiration date is not provided.

Enables the outbound services to be triggered during revocation.

NOTE   Revocation is not relevant for Sentinel LDK.

Specifies the authentication system being used.

Valid values:

DB—Database is used for authentication

LDAP—Active Directory is used for authentication

UID—UID authentication

SSO—Single Sign On authentication

The user name for an Active Directory account.

Specifies the value of the Identifier that was given at the time of configuring Sentinel EMS in Relying Party Trust in IdP.

Specifies the location of the keystore file.

Specifies the location of the IdP Signing Certificate. This certificate can be imported from the IdP.