Special and Reserved Enforcement Attributes
This page provides information about special and reserved attributes for a custom/third-party enforcement.
Special Enforcement Attributes
The following special attribute is available for custom/third-party enforcements:
KEY_FILE_NAME_TMPL
The KEY_FILE_NAME_TMPL attribute is used to specify the name and format of the generated license file.
NOTE This attribute is not supported for cases where a license key is not generated.
The purpose of the KEY_FILE_NAME_TMPL enforcement attribute is similar to the Administration Console property (in the vendor portal), License File Name Format, that allows configuring the license file name format globally for an enforcement.
What is allowed in KEY_FILE_NAME_TMPL? You can use static text and dynamic parameters in the license file name. You can include or exclude delimiters and/or an extension. Spaces are also allowed.
How to evaluate the license file name based on the KEY_FILE_NAME_TMPL attribute value? The string inside curly braces is evaluated as a dynamic expression and the string outside curly braces is treated as static text.
Which dynamic parameters are allowed? For the list of dynamic parameters that you can include in the license file name format, refer to the Sentinel EMS User Guide.
Examples
The following are some examples of the license file name format containing static and dynamic parameters:
>{entitlement.eid}-{activation.aid}.txt
>{customerName}.license
>{activationattribute.startDate}.license
Sample Payloads
The following is a sample payload for adding the KEY_FILE_NAME_TMPL enforcement attribute:
<enforcementAttribute> <name>KEY_FILE_NAME_TMPL</name> <dataType>STRING</dataType> <displayOrder>98.1</displayOrder> <isSharedAttribute>false</isSharedAttribute> <groupName>LKG_KeyType</groupName> <subGroupName></subGroupName> </enforcementAttribute>
After adding the enforcement, create license models with the same attributes you used in the enforcement. Here is a sample payload that demonstrates how to use the KEY_FILE_NAME_TMPL attribute in a license model:
<licenseModelAttribute>
<enforcementAttribute>
<name>KEY_FILE_NAME_TMPL</name>
<dataType>STRING</dataType>
<displayOrder>98.1</displayOrder>
<isSharedAttribute>false</isSharedAttribute>
<groupName>LKG_KeyType</groupName>
<subGroupName></subGroupName>
</enforcementAttribute>
<value>lservrc</value>
<encodeToBase64>false</encodeToBase64>
<modificationAction>NONE</modificationAction>
<endUserPermission>NONE</endUserPermission>
</licenseModelAttribute>
Reserved Enforcement Attributes
You must not add enforcement attributes with names that are used in Sentinel enforcements (Sentinel LDK, Sentinel RMS, Sentinel Fit, and Services) even if any Sentinel enforcement is not available.
Reserved enforcement attributes for all Sentinel enforcements are listed below:
Sentinel LDK
| LIC_TYPE | VIRTUAL_MACHINE |
| NETWORK | CONCURRENT_INSTANCES |
| ENABLE_CONCURRENCY | REMOTE_DESKTOP |
| NUMBER_OF_DAYS | EXPIRATION_DATE |
| ALLOW_DETACHING | APPLY_LICENSE |
| EXECUTIONS | COUNT_EACH |
Sentinel RMS
| SECONDARY_11_FINGERPRINT | SITE_LIC_7_INFO |
| USERNODE_3_CRITERIA | SECONDARY_1_INFO |
| PRIMARY_1_FINGERPRINT | CLIENT_4_FINGERPRINT |
| LOCAL_REQUEST_LOCKCRIT_FLAG | USERNODE_5_CRITERIA |
| SECONDARY_5_INFO | PRIMARY_5_FINGERPRINT |
| USERNODE_1_FINGERPRINT | NUM_CLIENT_LOCKED |
| USERNODE_7_CRITERIA | VENDOR_NUM_OF_SECRETS |
| PRIMARY_9_FINGERPRINT | USERNODE_5_FINGERPRINT |
| CLIENT_4_CRITERIA | DEPLOYMENT_TYPE |
| LICENSE_ID | SECONDARY_2_FINGERPRINT |
| IS_SL_LEASE | END_DATE |
| TRIAL_DURATION_HOURS | CLIENT_1_INFO |
| CLIENT_5_INFO | VENDOR_SECRETS_5 |
| VENDOR_PRIVATE_INFO | RENEW_FREQUENCY |
| CONCURRENCY_LIMIT | SHARING_LIMIT |
| CAPACITY_FLAG | PRIMARY_1_CRITERIA |
| PRIMARY_5_CRITERIA | ELAN_KEY_FLAG |
| PRIMARY_11_CRITERIA | VENDOR_INFO |
| NO_OF_NAMEDUSERS | ENFORCE_REDUNDANCY_MAJORITY |
| SHARING_CRITERIA | PRIMARY_1_INFO |
| PRIMARY_5_INFO | LICENSED_USER_ACCOUNT |
| SECONDARY_10_INFO | SECONDARY_9_CRITERIA |
| SITE_LIC_3_INFO | CODE_TYPE |
| SECONDARY_5_CRITERIA | SECONDARY_1_CRITERIA |
| SECONDARY_6_FINGERPRINT | SECONDARY_10_FINGERPRINT |
| NUM_USERNODE | USERNODE_2_INFO |
| SITE_LIC_6_INFO | FINGERPRINT_ONLY |
| SECONDARY_8_CRITERIA | LICENSE_VERSION |
| CLIENT_3_FINGERPRINT | SECONDARY_4_INFO |
| USERNODE_4_INFO | CLIENT_7_FINGERPRINT |
| PRIMARY_4_FINGERPRINT | USERNODE_6_INFO |
| LOCAL_REQUEST_LOCKCRIT_MIN_NUM | PRIMARY_8_FINGERPRINT |
| SECONDARY_8_INFO | CLIENT_3_CRITERIA |
| USERNODE_4_FINGERPRINT | VENDOR_SECRETS_3 |
| LICENSE_DURATION_IN_DAYS | CUSTOMER_ID |
| SECONDARY_1_FINGERPRINT | IS_NETWORK |
| START_DATE | SECONDARY_5_FINGERPRINT |
| CLIENT_7_CRITERIA | TRIAL_DURATION_DAYS |
| VENDOR_SECRETS_4 | CLIENT_4_INFO |
| USAGE_SYNC_FREQUENCY | VENDOR_PUBLIC_INFO |
| FLOATING_SOFT_USER_LIMIT | USAGE_TYPE |
| NUM_SERVERS | CAPACITY |
| NUMERIC_TYPE | PRIMARY_4_CRITERIA |
| GRACE_TIME_DURATION | PRIMARY_10_CRITERIA |
| ENFORCE_LICENSE_EXCLUSIVE | NAMED_USER_LICENSE |
| PRIMARY_8_CRITERIA | ALLOW_GRACE |
| PRIMARY_11_INFO | PRIMARY_4_INFO |
| REDUNDANT_SERVERS | SECONDARY_9_INFO |
| HOLDING_CRITERIA | SITE_LIC_2_INFO |
| PRIMARY_8_INFO | SECONDARY_4_CRITERIA |
| SECONDARY_9_FINGERPRINT | SITE_LIC_5_INFO |
| USERNODE_2_CRITERIA | SECONDARY_7_CRITERIA |
| LOG_ENCRYPT_LEVEL | CLIENT_2_FINGERPRINT |
| SECONDARY_3_INFO | USERNODE_4_CRITERIA |
| CLIENT_6_FINGERPRINT | PRIMARY_3_FINGERPRINT |
| USERNODE_6_CRITERIA | LOCAL_REQUEST_LOCKCRIT_FLOAT |
| PRIMARY_7_FINGERPRINT | SECONDARY_7_INFO |
| CLIENT_2_CRITERIA | USERNODE_3_FINGERPRINT |
| VENDOR_SECRETS_2 | START_LICENSE_FROM_ACTIVATION_DATE |
| USERNODE_7_FINGERPRINT | PRIMARY_11_FINGERPRINT |
| LICENSE_GENERATION_TIME | CLIENT_6_CRITERIA |
| SECONDARY_4_FINGERPRINT | DURATION |
| GRACE_PERIOD_ELAPSED_HOURS | FLOATING_USER_LIMIT |
| CLIENT_3_INFO | CLIENT_7_INFO |
| VENDOR_SECRETS_7 | KEY_TYPE |
| CRITERIA | USAGE_LIMIT |
| KEY_HOLDTIME_MINUTES | ENFORCE_CLOCK_TAMPERED |
| PRIMARY_3_CRITERIA | PRIMARY_7_CRITERIA |
| PRIMARY_9_CRITERIA | PRIMARY_10_INFO |
| GRACE_TIME | REDUNDANCY_MAJORITY_RULE |
| ALLOW_COMMUTER | LOCKING_MODE |
| PRIMARY_3_INFO | PRIMARY_7_INFO |
| SECONDARY_11_CRITERIA | ALLOW_VM_DETECTION |
| SITE_LIC_1_INFO | SECONDARY_8_FINGERPRINT |
| SECONDARY_3_CRITERIA | USERNODE_1_INFO |
| SITE_LIC_4_INFO | IS_TRIAL |
| SECONDARY_6_CRITERIA | SECONDARY_2_INFO |
| CLIENT_1_FINGERPRINT | CLIENT_5_FINGERPRINT |
| USERNODE_3_INFO | USERNODE_5_INFO |
| PRIMARY_2_FINGERPRINT | PRIMARY_6_FINGERPRINT |
| LOCAL_REQUEST_LOCKCRIT_REQUIRED | CLIENT_1_CRITERIA |
| SECONDARY_6_INFO | VENDOR_SECRETS_1 |
| USERNODE_2_FINGERPRINT | USERNODE_6_FINGERPRINT |
| USERNODE_7_INFO | LICENSE_VENDOR_INFO |
| PRIMARY_10_FINGERPRINT | SECONDARY_3_FINGERPRINT |
| CLIENT_5_CRITERIA | GRACE_PERIOD_DAYS |
| COLLECT_USAGE | CLIENT_2_INFO |
| COMMUTER_MAX_CHECKOUT_DAYS | VENDOR_SECRETS_6 |
| CLIENT_6_INFO | FINGERPRINT_REGISTRATION |
| VENDOR_COMMENTS | KEY_LIFETIME_MINUTES |
| CONCURRENCY_CRITERIA | PRIMARY_2_CRITERIA |
| LICENSE_TYPE | USE_AUTH_CODE |
| PRIMARY_6_CRITERIA | GRACE_LIMIT |
| PRIMARY_9_INFO | ALLOW_REDUNDANCY |
| IS_REDUNDANT | PRIMARY_2_INFO |
| OUTPUT_TYPE | LICENSED_USER_ACCOUNT_LIMIT |
| PRIMARY_6_INFO | SECONDARY_10_CRITERIA |
| SECONDARY_11_INFO | NUM_SUBNET |
| SECONDARY_7_FINGERPRINT | SECONDARY_2_CRITERIA |
| USERNODE_1_CRITERIA |
Sentinel Fit
| LICENSE_SIGNING | PERPETUAL |
| VENDOR_STRING | BATCH_CODE |
| ACTION_REQUIRED | IS_WWU |
| DEVICE_FINGER_PRINT | IS_DEVICE_ENABLED |
| USER_LIMIT | END_DATE |
Services
| START_LICENSE_FROM_ACTIVATION_DATE | ACTIVATION_COMMENTS |
| START_DATE | END_DATE |
| LICENSE_DURATION_IN_DAYS | LICENSE_VENDOR_INFO |