parse

Interface Information

>This API belongs to SentinelLicgenParser.dll.

>The corresponding library is Sentinel RMS license decode library.

String parse(String input)

Use this API to decode and view the license details.

Parameters

Parameter	Description
input [in]	License string to be decoded.

Output

<?xml version="1.0" encoding="UTF-8"?>
<license>
	  <feature>
		     <codeType>1</codeType>
		    <isStandalone>0</isStandalone>
		    <featureName>licensewithnolimit</featureName>
		     <featureVersion>v42</featureVersion>
		    <licType>0</licType>
		    <birthTime>No Check</birthTime>
		    <deathTime>Never</deathTime>
		     <numLicenses>1</numLicenses>
		     <softNumLicenses>1</softNumLicenses>
		     <isAdditive>1</isAdditive>
		     <vmDetection>0</vmDetection>
		     <checkTimeTamper>1</checkTimeTamper>
		     <keyLifeTime>5</keyLifeTime>
		     <logEncryptLevel>1</logEncryptLevel>  
		     <licenseOutputFormat>0</licenseOutputFormat>
		     <licenseVersion>19</licenseVersion>
		     <vendorInfo/>
		     <plainVendorInfo/>
		     <sharingCrit>0</sharingCrit>
		     <sharingLimit>0</sharingLimit>
		     <holdingCrit>0</holdingCrit>
		     <holdTime>0</holdTime>
		     <subNetInfo/>
		     <clientLockingInfo/>
		     <isRedundant>0</isRedundant>
		     <majorityRule>0</majorityRule>
		     <serverLockingInfo>
			       <lockInfoPrimary/>
			       <lockInfoSecondry/>      
		</serverLockingInfo>
		     <trialDays>0</trialDays>
		     <trialSeconds>0</trialSeconds>
		     <isCommuter>0</isCommuter>
		     <commuterMaxCheckoutDays>0</commuterMaxCheckoutDays>
		     <gracePeriodFlag>0</gracePeriodFlag>
		     <gracePeriodCalendarDays>0</gracePeriodCalendarDays>
		     <gracePeriodElapsedHours>0</gracePeriodElapsedHours>
		     <localRequestLockCritFlag>0</localRequestLockCritFlag>
		    <localRequestLockcritMinNum>1</localRequestLockcritMinNum>
		    <localRequestLockCritRequired>4</localRequestLockCritRequired>
		    <localRequestLockCritFloat>0</localRequestLockCritFloat>
		    <licSource>0</licSource>
		    <eid/>
		    <pid>0</pid>
		    <fid>0</fid>
		    <aid/>
		    <cloudUsageFlag>0</cloudUsageFlag>
		    <activationBirthTime>0</activationBirthTime>
		    <activationExpiryTime>0</activationExpiryTime>
		<licenseVendorInfo>licenseInfo</licenseVendorInfo>
		<licenseGenerationTime>2163217208</licenseGenerationTime>
		<userAccountLimit>0</userAccountLimit>
	</feature>
</license>

Element	Description
Feature Information
featureName	The name of the feature.
featureVersion	The version of the feature.
License Type Information
codeType	The license code type. The possible types are: 0 - Short-numeric Licenses 1 - Long Licenses 2 - Short licenses (available for license versions earlier than 8.1.x).
licType	Contains any of the following information regarding the license type: 0 - Normal 1 - Trial
isStandalone	Contains any of the following information regarding the license type: 0 - for a network license 1- for a standalone license 2 - for a repository license 3 - for a cloud LM license
isAdditive	Contains any of the following information regarding the license type: 0 - for an additive license 1 - for an exclusive license 2 - for an aggregate license
licenseOutputFormat	Contains any of the following information regarding the license type: 0 - for an encrypted license 1 - for an expanded readable license 2 - for a concise readable license
Number of Licenses Information
numLicenses	Total hard limit for this feature. From RMS 9.5 onwards, this attribute supports license hard limit up to 4,294,967,294. This is applicable to license version 20 (or above).
softNumLicenses	Total soft limit (for alerts) on the number of concurrent users of this feature. From RMS 9.5 onwards, this attribute supports soft limit up to 4,294,967,294. This is applicable to license version 20 (or above).
userAccountLimit	Applicable to SCL Add-on for RMS only for Connected (Cloud LM) mode with version 23 and later licenses. Stores the maximum number of named users that can consume this license.
License Lifetime Information
keyLifeTime	Total license lifetime (in seconds) for this feature .
License Locking Information
clientLockingInfo	Stores the client locking information.
serverLockingInfo	Stores the License Manager locking information.
lockInfoPrimary	Primary criteria locking information for supporting server-locking.
lockInfoSecondry	Secondary criteria locking information for supporting server-locking.
License Sharing Information
sharingCrit	Contains the license sharing criteria, which can be one of the following values: 0 - No sharing 1 - License sharing on the basis of a common user name. 2 - License sharing on the basis of the system where the licensed feature is being run. 3 - License sharing on the basis of the X-display ID of a UNIX system. 4 - License sharing on the basis of a custom license sharing mechanism you implemented, which is set using the SNTL_ATTR_APPCONTEXT_VENDOR_DEFINED_SHARINGID application context attribute.
sharingLimit	The limit on how many copies of the licensed application can share the same license.
License Holding Information
holdingCrit	Contains the license holding criteria, which can be one of the following values: 0 - No held licenses. 1 - The client application specifies the hold time. 2 - The license code specifies the hold time.
holdTime	The hold time specified for licenses issued for this feature.
Time Tampering Information
checkTimeTamper	Contains the clock tampering detection policy, which can be one of the following values: 0 - No time tamper to be detected 1 - Time tamper detection allowed
License Manager Redundancy Information
isRedundant	Contains any of the following values about the License Manager redundancy setting: 0 - The license is non-redundant 1 - The license is redundant
majorityRule	Contains any of the following values about the applicability of the majority rule (on or off): 0 - No majority 1 - Majority
subNetInfo	The number of subnet specifications provided for the site.
Commuter Information
isCommuter	Whether license commute action is allowed or not. Contains any of the following value: 0 - The commute action is not allowed. 1 - The commute action is allowed.
commuterMaxCheckoutDays	The maximum number of days a commuter license can be checked out for.
Usage Log Information
logEncryptLevel	Contains any of the following values about the encryption level in the network license for the License Manager’s usage log file: 0 - The system administrator is allowed to set the encryption level. 1 - Transaction data will be logged for this license code with no encryption. 2 - Transaction data will be readable by the customer, but tampering with or deleting an entry can be detected. 3 - Transaction data will be readable by the customer except for license usage data (which will be encrypted), but tampering with or deleting an entry can be detected. 4 - All transaction data for the license code will be encrypted. Tampering with or deleting an entry will not be prevented, but can be detected.
Local License Locking-Related Information
localRequestLockCritFlag	Contains the flag value that defines whether the local license request locking criteria is used or not for the commuter, repository, and grace license: 0 - Local license request criteria is not used 1 - Local license request criteria is used
localRequestLockCritRequired	The ORed decimal value of necessary criteria that must be met for making the licenses available to a local client.
localRequestLockCritFloat	The ORed decimal value of desired criteria that must be met for making the licenses available to a local client.
localRequestLockCritMinNum	The minimum number of locking license criteria that must be met for making the licenses available to a local client. (Joy)
Grace Information
gracePeriodFlag	Contains the flag value that defines whether grace period for a license is available or not: 0 - When the grace period is not allowed 1 - When the standard grace period is provided
gracePeriodCalendarDays	The number of days the grace period will last for.
gracePeriodElapsedHours	The number of hours the grace period will last for.
Vendor Info
vendorInfo	The vendor-defined information string.
plainVendorInfo	The public vendor information included in the license.
licenseVendorInfo	License vendor information included in the license and applicable to version 19 licenses and above.
License Version Information
licenseVersion	Contains the Sentinel RMS license version.
License Validity Information
birthTime	>For On-premises mode, this is the license start date in time_t. >For Lease mode, this represents the start time of the lease period (and not of the license). >Returns "No Check" as the output value, when birth time is not specified, during license generation.
deathTime	>For On-premises mode, this is the license expiration date in time_t. >For Lease mode, this represents the expiration time of the lease period (and not of the license). >Returns "Never" as the output value, when death time is not specified, during license generation.
activationBirthTime	activationBirthTime and activationExpiryTime denote the duration of the complete license. These do not denote the lease time period (lease time period is denoted by attributes birthTime and deathTime). For example, activationBirthTime (2021-06-16T11:13:00Z) and activationExpiryTime (2022-06-15T11:13:00Z) denote the license duration of one year. The lease period duration—denoted by the birthTime (2021-06-17T07:52:00Z) and deathTime (2021-09-15T08:07:00Z values—is three months. The activationBirthTime and activationExpiryTime attributes are filled only for Lease mode licenses. These attributes are applicable for v17 and above licenses. Currently, for on-premise modes, licenses generated using Sentinel EMS, activationBirthTime and activationExpiryTime values are not filled.
activationExpiryTime
Trial License-Related Information
trialDays	The number of trial days set. Valid only if trial days is enforced.
trialSeconds	The number of trial hours set, converted into seconds. Valid only if trial hours is enforced.
VM-Related Information
vmDetection	Contains any of the following values about the VM detection policy: 0 - license requests are allowed. 1- license requests are not allowed.
Sentinel EMS-Related Information
eid	Entitlement ID (EID) used to identify entitlements.
fid	Feature ID. This field is applicable for the Lease mode.
pid	Reserved for future use.
aid	Authorization ID. It is a unique identifier auto-generated for each licensed feature in an entitlement. It is used for tracking the usage associated with a feature-entitlement combination. This field is applicable to v16 (and later) Sentinel RMS licenses activated using Sentinel EMS. NOTE This field is not the same as the Activation ID of Sentinel EMS. The field may be renamed in the upcoming releases.
cloudUsageFlag	This field is applicable for all deployment modes. It decides whether the Cloud-based usage data is being generated or not. The possible values are: >0 - The Cloud-based usage data is not generated. >1 - The Cloud-based usage data is being generated.
licSource	This field decides whether the license is applicable for the Lease mode or not. > 1 - License is supported for the Lease mode. >0 - License is not supported for the Lease mode.
licenseGenerationTime	This field is set internally by Sentinel products. Setting a value for this field may produce unexpected results. It is applicable to version 19 and above licenses.

Returns

The status code SNTL_LICGEN_SUCCESS is returned, if successful. Otherwise, a specific status code is returned indicating the reason for failure. For a complete list of error codes, see "Unified API - License Generation and Revocation Error Codes".

Exception Handling

If unsuccessful, throws LicgenException