Skip to content

Commit 9461e02

Browse files
authored
docs(common): Use exact license error messages and add error codes (#2878)
* Use correct license key errors and codes * Polish error messages * Polish FAQ * Update ci-cd-license-key.md * Update troubleshooting/license-key-errors.md
1 parent c95456b commit 9461e02

File tree

3 files changed

+46
-39
lines changed

3 files changed

+46
-39
lines changed

deployment/ci-cd-license-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ steps:
6363
### Use TELERIK_LICENSE_PATH
6464

6565
1. [Add a secure file](https://learn.microsoft.com/en-us/azure/devops/pipelines/library/secure-files) and grant any necessary permissions to use it in the pipeline.
66-
1. [Download the secure file](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-secure-file-v1?view=azure-pipelines) during pipeline run. The secure file path is available through the [`secureFilePath` output](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-secure-file-v1?view=azure-pipelines#output-variables).
66+
1. [Download the secure file](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-secure-file-v1?view=azure-pipelines) in a task with a `name`. The secure file path is available to other tasks through the [`secureFilePath` output](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/download-secure-file-v1?view=azure-pipelines#output-variables).
6767
1. Set the `TELERIK_LICENSE_PATH` environment variable in all tasks, steps, or scripts that build and publish the Blazor app.
6868

6969
>caption Using a TELERIK_LICENSE_PATH environment variable in Azure Pipeline YAML

installation/license-key.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The new license key includes information about all previous purchases. This proc
6363

6464
## Frequently Asked Questions
6565

66-
#### Does the license key expire?
66+
### Does the license key expire?
6767

6868
Yes, the license key expires at the end of your subscription:
6969

@@ -79,7 +79,7 @@ You need to download and install a new license key after:
7979

8080
An expired [perpetual license](https://www.telerik.com/purchase/faq/licensing-purchasing#licensing) key is valid for all Telerik UI for Blazor versions published before the license expiration date.
8181

82-
#### Will Telerik UI for Blazor function with an expired license key?
82+
### Will Telerik UI for Blazor work with an expired license key?
8383

8484
This depends on the [Telerik UI for Blazor license type (perpetual, subscription, or trial)](https://www.telerik.com/purchase/faq/licensing-purchasing#licensing):
8585

@@ -93,44 +93,45 @@ Scenarios that do not match the above three descriptions result in the following
9393
* A watermark appears on Telerik UI for Blazor components.
9494
* [A warning message appears in the application's build log](slug:troubleshooting-license-key-errors).
9595

96-
#### I updated the Telerik UI for Blazor version in my project and license errors appeared. Why?
96+
### I updated Telerik UI for Blazor in my app and got license errors. Why?
9797

9898
The most likely cause is that the new Telerik UI for Blazor version was released after the expiration date of your current license or license key. To fix this issue:
9999

100100
1. Renew your Telerik UI for Blazor license if necessary.
101101
1. [Update your license key](slug:installation-license-key)
102102

103-
#### Can I use the same license key in multiple builds?
103+
### Can I use the same license key in multiple builds?
104104

105105
You can use one license key in multiple pipelines, builds, and environments. However, each individual developer must use their own unique personal license key in their development environment.
106106

107-
#### Do I need an Internet connection to activate the license?
107+
### Do I need Internet to activate the license?
108108

109109
No, the license validation and activation occur offline.
110110

111-
#### Do I have to add the license key to source control?
111+
### Should I add the license key to source control?
112112

113113
No, do not add the `telerik-license.txt` license key file or its contents to source control.
114114

115115
Do not store the license key in plain text in GitHub Actions Workflow definitions. Build servers [must use the `TELERIK_LICENSE` environment variable](slug:deployment-license-key).
116116

117-
#### What happens if both the environment variable and the license key file are present?
117+
### What happens if I use both the environment variable and the license key file?
118118

119119
If both the `TELERIK_LICENSE` environment variable and the `telerik-license.txt` file are present, then the environment variable will be used.
120120
To use the license key file, unset the environment variable.
121121

122-
#### What happens if several license key files exist?
122+
### What happens if several license key files exist?
123123

124124
If both a global and a project-specific `telerik-license.txt` files exist, then the project-specific license key will be used.
125125

126-
#### My team has more than one license holder. Which key do we have to use?
126+
### My team has multiple licenses. Which key should we use?
127127

128128
To activate Telerik UI for Blazor:
129129

130130
* [Every developer must be assigned their own license or seat](https://www.telerik.com/purchase/faq/licensing-purchasing).
131131
* Every developer must use a license key that is associated with their personal Telerik account.
132+
* You can use any of the available [license keys in cloud build CI/CD environments](slug:deployment-license-key).
132133

133-
#### Are earlier Telerik UI for Blazor versions affected?
134+
### Are earlier Telerik UI for Blazor versions affected?
134135

135136
No, versions up to **7.1.0** released prior to February 2025 do not require a license key.
136137

troubleshooting/license-key-errors.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,51 +18,57 @@ This page provides solutions for license key errors that you may encounter while
1818

1919
A Telerik license key error may occur in the following scenarios:
2020

21-
* Missing license key.
22-
* Using an expired subscription license after the end of the subscription term.
23-
* Using a perpetual license with a product version that was released outside the validity period of your license.
24-
* Using an expired trial license.
25-
* Using an outdated license key after making renewals or purchases.
26-
* Using a license key that doesn't include Telerik UI for Blazor.
27-
* Using conflicting license keys in the same environment. For example, using one global license key and one in the app. Or, using a license key file together with an environment variable in CI/CD environment.
21+
* The license key is missing or not set up correctly.
22+
* The license key is outdated or does not include the product version that you are using.
23+
* Your subscription license or trial has expired.
24+
* You have different conflicting license keys in the same environment. For example, using one global license key and one in the app. Or, using a license key file together with an environment variable in CI/CD environment.
2825

29-
Refer to the error messages below for specific tips.
26+
Refer to the specific error messages and tips below.
3027

3128
## Error Messages
3229

33-
* [No license key is detected](#no-license-key-is-detected)
34-
* [Invalid license key](#invalid-license-key)
35-
* [Your subscription license has expired](#your-subscription-license-has-expired)
36-
* [Your perpetual license is invalid](#your-perpetual-license-is-invalid)
37-
* [Your trial license has expired](#your-trial-license-has-expired)
38-
* [Your license is not valid for the detected product(s)](#your-license-is-not-valid-for-the-detected-products)
30+
### No Telerik or Kendo UI product references detected in project (TKL001)
3931

40-
### No license key is detected
32+
This error can occur when a project references `Telerik.Licensing`, but not any other Telerik packages. In this case, remove the `Telerik.Licensing` package from the project. If your scenario is different, [contact Technical Support](https://www.telerik.com/account/support-center).
4133

42-
[Install a license key file](slug:installation-license-key). If you already downloaded it, make sure it's [saved at the right place](slug:installation-license-key#manual-installation).
34+
### No Telerik and Kendo UI License file found (TKL002)
4335

44-
### Invalid license key
36+
The error means that the license key is missing or not set up corrently. For example, the environment variable is not set or [the license file may be at the wrong place](slug:installation-license-key#manual-installation).
4537

46-
Follow the [automatic](slug:installation-license-key#automatic-installation) or [manual](slug:installation-license-key#manual-installation) installation steps from scratch.
38+
[Install a license key](slug:installation-license-key) again. Also check how to [set up a license key in CI/CD environments](slug:deployment-license-key).
4739

48-
### Your subscription license has expired
40+
### Corrupted Telerik and Kendo UI License Key content (TKL003)
4941

50-
<a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug:installation-license-key#license-key-updates).
42+
The license key is detected, but its value is invalid and cannot be decrypted. For example, if you have set a `TELERIK_LICENSE` environment variable through the Windows operating system's UI, then it may be truncated. In such cases, remove the environment variable and use a license key file instead.
5143

52-
### Your perpetual license is invalid
44+
Follow the [automatic](slug:installation-license-key#automatic-installation) or [manual](slug:installation-license-key#manual-installation) installation steps from scratch. Also check how to [set up a license key in CI/CD environments](slug:deployment-license-key).
5345

54-
You are using a product version released outside the validity period of your perpetual license. To remove the error message, do either of the following:
46+
### Unable to locate licenses for all products (TKL004)
5547

56-
* <a href="https://www.telerik.com/account/your-licenses" target="_blank">Renew your subscribtion</a>. Then, [update your license key](slug:installation-license-key#license-key-updates).
57-
* Downgrade your app to a Telerik UI for Blazor version that was released within the subscription period of your perpetual license.
48+
Your license is not valid for the detected product(s), because it doesn't include them.
5849

59-
### Your trial license has expired
50+
[Review the purchase options for Telerik UI for Blazor](https://www.telerik.com/purchase/blazor-ui). If you have already purchased the required license, then, [update your license key](slug:installation-license-key#license-key-updates).
6051

61-
<a href="https://www.telerik.com/purchase/blazor-ui" target="_blank">Purchase a commercial license to continue using Telerik UI for Blazor</a>.
52+
### Telerik UI for Blazor is not listed in your current license file (TKL101)
6253

63-
### Your license is not valid for the detected product(s)
54+
Your license key does not include Telerik UI for Blazor.
6455

65-
<a href="https://www.telerik.com/purchase/blazor-ui" target="_blank">Review the purchase options for Telerik UI for Blazor</a>. Then, [update your license key](slug:installation-license-key#license-key-updates).
56+
[Review the purchase options for Telerik UI for Blazor](https://www.telerik.com/purchase/blazor-ui). If you have already purchased the required license, then, [update your license key](slug:installation-license-key#license-key-updates).
57+
58+
### Your current license has expired (TKL102)
59+
60+
This error applies to perpetual licenses. It means that you are using a product version released outside the validity period of your license. To remove the error message, do either of the following:
61+
62+
* [Renew your license](https://www.telerik.com/account/your-licenses) and then, [update your license key](slug:installation-license-key#license-key-updates).
63+
* Use a Telerik UI for Blazor version that was released within the subscription period of your perpetual license.
64+
65+
### Your subscription has expired (TKL103, TKL104)
66+
67+
This error applies to subscription licenses. [Renew your subscription](https://www.telerik.com/account/your-licenses) and then, [update your license key](slug:installation-license-key#license-key-updates).
68+
69+
### Your trial expired (TKL105)
70+
71+
[Purchase a commercial license to continue using Telerik UI for Blazor](https://www.telerik.com/purchase/blazor-ui).
6672

6773
## See Also
6874

0 commit comments

Comments
 (0)