How to Resolve Licensing Trial/Invalid Pop-up Issues?
If a Syncfusion trial pop-up or watermark appears in your application, it indicates that the license key is missing, invalid, or expired.
This article explains the steps to resolve the issue for projects using Syncfusion components via NuGet from https://www.nuget.org/ or Essential Studio installer.
Syncfusion license keys are specific to both the major version and edition of the product. The license key, a unique string, must be registered before initializing any Syncfusion controls in your application to ensure proper functionality and compliance.
If you use Syncfusion assemblies, NuGet packages, or scripts from the trial installer, nuget.org, npm, CDN, or if you upgrade from one version to another (e.g., from v30.* to v31.*), you must generate and register the corresponding license key in your projects. Failure to do so will cause trial license warnings.
Refer to the following knowledge base article to identify the appropriate license key version for your application:
Common Causes of the Pop-up
• License key not registered in the application.
• Use of an expired trial key (30-day limit).
• Version mismatch between assemblies and license key.
• Invalid or incorrect platform license key.
• License key not registered in the script file.
License key not registered in the application / Trial Expired
If a Syncfusion® license key is not registered in your application or the trial key has expired after 30 days, the following error message will appear:
Error message: This application was built using a trial version of Syncfusion® Essential Studio®. You should include the valid license key to remove the license validation message permanently.
Solution:
Generate a valid license key from here Licensed users or Trial users for a specific version and platform or License keys can also be generated from the Claim License Key page by clicking the “Claim License” button click from Syncfusion® licensing warning message.
Refer to this help topic for more details.
In your application, register the generated license key. Please refer to this help topic for information on registering the license key.
Invalid key / Version mismatch
If the application is registered with an invalid key, a license key from another version, or a different platform’s license key, the following error message will appear when launching the application:
Error Message: The included Syncfusion® license key is invalid.
Solution:
Generate a valid license key from here Licensed users or Trial users for a specific version and platform or License keys can also be generated from the Claim License Key page by clicking the “Claim License” button click from Syncfusion® licensing warning message.
Refer to this help topic for more details.
License key not registered in script file
For applications using EJ2 JavaScript files, follow these steps to generate and register the license key.
License key validation was introduced for Essential JS2 platforms starting from the 2022 Volume 1 release. This validation requires developers to register a valid license key when referencing any of the latest packages from npm or CDN.
For more information, see the following blog:
Ensure Version Consistency
• All Syncfusion assemblies or NuGet packages must correspond to the license key version.
• When upgrading packages, update the license key accordingly.
• Clean and rebuild the project after making changes.
Validate in CI/CD (Optional)
In build servers, use Syncfusion’s LicenseKeyValidator utility to verify proper licensing during CI pipelines.
Programmatically check the license key registration (Optional)
You can programmatically verify license key registration using the SyncfusionLicenseProvider.Validate method. Note that this is an internal method and will not appear in IntelliSense; you must type the method name manually.
Example:
bool isvalid = SyncfusionLicenseProvider.ValidateLicense(Platform.ASPNETCore);
Below is an example of Platform enumeration values.
This code verifies if the license key is valid for the specified platform. If the Boolean variable isValid is true, the license key is valid; if false, the key is invalid.
Please insert the above code snippet before and after the license key registration method to verify the returned value.
Note: Do not use this code in production. It is intended for internal validation only.
Note:
If the issue persists after following these steps, please submit a support ticket to Syncfusion Support including the following details for further assistance:
-
The Syncfusion license key registered in your application.
-
A screenshot of the error message or issue encountered.
-
The version numbers of the Syncfusion assemblies referenced in your project.
-
A screenshot of the code section where the Syncfusion license key is registered.
-
A sample application demonstrating the issue.
