Skip to content

Polish licensing documentation #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions licensing/license-agreement.md

This file was deleted.

30 changes: 13 additions & 17 deletions licensing/license-errors-and-warnings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,10 @@ position: 7

Starting with the 2025 Q1 release, using the Telerik Report Server without a license or with an invalid license causes specific license warnings and errors. This article defines what an invalid license is, explains what is causing it, and describes the related license warnings and errors.

The implementation of the 2025 product licensing requirements will occur in two phases:
If a valid license cannot be found:

* Phase 1 - Starting with the 2025 Q1 release, a missing or invalid license for the trial distributions causes [trial message watermark in the reports]({%slug license-errors-and-warnings%}). The commercial distributions of the product do not exhibit any functional restrictions.
* Phase 2 - Starting with the 2025 Q2 release, there will be only one distribution of the product with different licenses. A missing or invalid license will result in the following [indicators]({%slug license-errors-and-warnings%}):

- A watermark appears on each report document page.
- A warning message appearing in the log file generated after attaching a Trace Listener to the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%}):
- A watermark appears on each document page in the report.
- A [warning message](#license-warnings-and-errors) appears in the log file generated after attaching a Trace Listener to the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%}):

````
Telerik and Kendo UI Licensing warning TKL002: No Telerik and Kendo UI License file found.
Expand All @@ -43,7 +40,6 @@ Telerik and Kendo UI Licensing warning TKL002: No Telerik and Kendo UI License f
Telerik and Kendo UI Licensing warning TKL004: Unable to locate licenses for all products.
````


## Invalid License

An invalid license can be caused by any of the following:
Expand All @@ -59,20 +55,20 @@ An invalid license can be caused by any of the following:

Using the Telerik Report Server with an expired or missing license, the `Telerik.Licensing` will indicate the following errors or conditions:

|**Condition or Error**|**Message Code**|**Solution**|
|Condition or Error|Message Code|Solution|
|----|----|----|
|`No license key is detected`|TKL002|[Install a license key]({%slug license-key%}) to activate Telerik Report Server and remove the error message.|
|`Invalid license key`|TKL003|[Download a new license key]({%slug license-key%}#downloading-the-license-key) and install it to activate Telerik Report Server and remove the error message.|
|`Your subscription license has expired.`|TKL103; TKL104|Renew your subscription and [download a new license key]({%slug license-key%}#downloading-the-license-key).|
|`Your perpetual license is invalid.`|TKL102||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: <ul><li>Renew your subscription and [download a new license key]({%slug license-key%}#downloading-the-license-key)</li><li>Downgrade to a Telerik Report Server version covered by your perpetual license, as specified in the message.</li></ul>|
|`Your trial license has expired.`|TKL105|Purchase a commercial license to continue using the product.|
|`Your license is not valid for the detected product(s).`|TKL101|Review the purchase options for the listed products.|

Starting with the 2025 Q2 release of Telerik Report Server, all conditions above will be treated as errors.
|`No Telerik and Kendo UI License file found`|TKL002|[Set up a license key]({%slug license-key%}) to activate Telerik Report Server and remove the error message.|
|`Corrupted Telerik and Kendo UI License Key content`|TKL003|[Download a new license key]({%slug license-key%}#downloading-the-license-key) and use it to activate Telerik Report Server and remove the error message.|
| `Unable to locate licenses for all products` | TKL004 | Your license is not valid for all Telerik and Kendo products added to your project. If you have already purchased the required license, then [update your license key]({%slug license-key%}). |
|`Your subscription has expired`|TKL103; TKL104|Renew your subscription and [download a new license key]({%slug license-key%}#downloading-the-license-key).|
|`Your current license has expired`|TKL102|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: <ul><li>Renew your subscription and [download a new license key]({%slug license-key%}#downloading-the-license-key)</li><li>Downgrade to a Telerik Report Server version covered by your perpetual license, as specified in the message.</li></ul>|
|`Your trial expired`|TKL105|Purchase a commercial license to continue using the product.|
|`Telerik Reporting is not listed in your current license file`|TKL101|Review the purchase options for the listed products.|
| `No Telerik or Kendo UI product references detected in project.` | TKL001 | If you use Telerik products and see this message, update the `Telerik.Licensing` package to version `1.4.9` or later. If you do not use Telerik products, remove the `Telerik.Licensing` NuGet reference from your project |

# See Also

* [Setting Up Your License Key]({%slug license-key%}))
* [Setting Up Your License Key]({%slug license-key%})
* [Frequently Asked Questions about Your Telerik Report Server License Key]({%slug license-frequently-asked-questions%})
* [License Agreement](https://www.telerik.com/purchase/license-agreement/report-server)
* [Troubleshooting Report Server]({%slug troubleshoot-report-server%})
Expand Down
62 changes: 12 additions & 50 deletions licensing/license-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,62 +18,26 @@ Yes, the license key expires at the end of your support subscription:
* For trial users, this is at the end of your 30-day trial.
* For commercial license holders, this is when your subscription term expires.

You will need to obtain and install a new license key after starting a trial, renewing a license, or upgrading a license.
You must download a new license each time you start a trial, buy a license, renew a license, upgrade a license.

> An expired perpetual license key is valid for all Telerik Report Server versions installed before its expiration date.
An expired perpetual license key is valid for all Telerik Report Server versions installed before its expiration date.

## Will the product function with an expired license key?

This depends on your license type.
This depends on the [Telerik Report Server license type (perpetual, subscription, or trial)](https://www.telerik.com/purchase/faq/licensing-purchasing#licensing):

* __Perpetual licenses__ will continue to function normally with an expired license key.
* *Perpetual licenses* function normally with an expired license key, as long as the application is using a Telerik Report Server version that was released before the expiration date of the license.
* *Subscription licenses* function normally in already deployed applications, but you cannot rebuild and republish the app.
* *Trial licenses* function normally only within the 30-day trial period.

The following will happen only if you update or install a Report Server version that is released after the expiration date of the license:
If none of the above conditions are met, the following behaviors occur:

- A watermark appears on each report document page
- A warning message similar to the one shown below is logged in the trace log after attaching a Trace Listener to the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%})

* __Subscription licenses__. The following will happen if you try to run the application:

- A watermark appears on each report document page.
- A warning message similar to the one shown below is logged in the trace log after attaching a Trace Listener to the Report Server Manager and Report Server Agent:

* __Trial licenses__. The following will happen if you try to run the application:

- A watermark appears on each report document page.
- A warning message similar to the following is logged in the trace log after attaching a Trace Listener to the Report Server Manager and Report Server Agent:

````
Telerik and Kendo UI Licensing warning TKL002: No Telerik and Kendo UI License file found.
Telerik and Kendo UI Licensing warning TKL002: The following locations were searched:
Telerik and Kendo UI Licensing warning TKL002: * TELERIK_LICENSE (EnvironmentVariable)
Telerik and Kendo UI Licensing warning TKL002: * KENDO_UI_LICENSE (EnvironmentVariable)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\Telerik.ReportServer.Web\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\Telerik.ReportServer.Web\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\Services\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\Services\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\Telerik Report Server\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\Progress\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Program Files (x86)\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\telerik-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\kendo-ui-license.txt (RecursiveFilePath)
Telerik and Kendo UI Licensing warning TKL002: * C:\Users\user1\AppData\Roaming\Telerik\telerik-license.txt (UserDirectory)
Telerik and Kendo UI Licensing warning TKL002: * C:\Users\user1\AppData\Roaming\Telerik\kendo-ui-license.txt (UserDirectory)
Telerik and Kendo UI Licensing warning TKL002: Activate a License Key file at https://prgress.co/3PBSVoC
Telerik and Kendo UI Licensing warning TKL101: Telerik Reporting is not listed in your current license file.
Telerik and Kendo UI Licensing warning TKL004: Unable to locate licenses for all products.
````

See the [Invalid License]({%slug license-errors-and-warnings%}#invalid-license) section for more information.

Note that future updates of Telerik Report Server may restrict or disable some features when no valid license is present.
* A watermark appears on each report document page.
* A [warning message]({%slug license-errors-and-warnings%}) is logged in the trace log after attaching a Trace Listener to the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%}).

## I updated the Telerik Report Server and the invalid license errors have appeared. What is the cause of this behavior?

If this happens, the possible reason is that the end date of the license activated in your application is before the release date of the newly installed product. To fix this issue:
The most likely cause is that the new Telerik Report Server version was released after the expiration date of your current license or license key. To fix this issue:

1. [Download a new license key]({%slug license-key%}#downloading-the-license-key).
1. [Activate the new license key]({%slug license-key%}#activating-telerik-report-server) in your project.
Expand All @@ -82,8 +46,6 @@ If this happens, the possible reason is that the end date of the license activat

No, the license activation and validation are performed entirely offline.

The license is not validated with our services at any point in the project lifecycle.

## What happens if both the environment variable and the license key file are present?

If both the `TELERIK_LICENSE` environment variable and the `telerik-license.txt` file are present, then the environment variable will be used.
Expand All @@ -92,12 +54,12 @@ To enforce the use of the license key file, unset the environment variable.

## Are earlier versions of Telerik Report Server affected?

No, versions released before __January 2025__ do not require a license key.
No, versions released before January 2025 do not require a license key.

# See Also

* [License Activation Errors and Warnings]({%slug license-errors-and-warnings%})
* [Setting Up Your License Key]({%slug license-key%}))
* [Setting Up Your License Key]({%slug license-key%})
* [License Agreement](https://www.telerik.com/purchase/license-agreement/report-server)
* [Troubleshooting Report Server]({%slug troubleshoot-report-server%})
* [Troubleshooting Report Server for .NET]({%slug troubleshoot-report-server-net%})
31 changes: 13 additions & 18 deletions licensing/setting-up-your-telerik-repor-server-license-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: "Learn how to set up the Telerik Report Server License Key."
slug: license-key
tags: license, key, telerik, report, server
published: True
previous_url: /licensing
previous_url: /licensing, /licensing/license-agreement
position: 1
---

Expand All @@ -14,41 +14,36 @@ Starting with the Q1 2025 release, the Telerik Report Server requires activation

An invalid license results in [error and warning]({%slug license-errors-and-warnings%}) indicators such as watermarks and banners.

The implementation of the 2025 licensing mechanism will occur in two phases:

- Phase 1 - Starting with the 2025 Q1 release, a missing or invalid license for the trial distributions causes [trial message watermark in the reports]({%slug license-errors-and-warnings%}). The commercial distributions of the product do not exhibit any functional restrictions.
- Phase 2 - Starting with the 2025 Q2 release, there will be only one distribution of the product with different licenses. A missing or invalid license will result in [run-time indicators]({%slug license-errors-and-warnings%}), such as watermarks.

Note that future updates of the product may restrict or disable some features when no valid license is present. You can send us feedback through the _Contact Us_ form or by [opening a support ticket](https://www.telerik.com/account/support-center/contact-us?utm_source=licensing&utm_medium=console&utm_campaign=no_references).

## Downloading the License Key

To download a license key for the Telerik Report Server, you must have either a commercial or a trial license. If you do not have a license, you can sign up for a [free trial](https://www.telerik.com/account/trials) first, and then follow the steps below.
To download a license key for the Telerik Report Server, you must have either a commercial or a trial license. If you do not have a license, sign up for a [free trial](https://www.telerik.com/account/trials) first, and then follow the steps below.

1. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys) page in your Telerik account.

1. Click the **Download License Key** button.

![Download License Key](images/download-license-key.png)

Alternatively, the [Progress Control Panel](https://www.telerik.com/download-trial-file/v2/control-panel) will automatically download and store your license key in your home directory. You may use this file to [activate the Report Server](#activating-telerik-report-server).
Alternatively, use the [Progress Control Panel](https://www.telerik.com/download-trial-file/v2/control-panel) to install the Telerik Report Server. The Progress Control Panel automatically downloads the license key file to your home directory. Use the license key file to [activate the Report Server](#activating-telerik-report-server).

## Activating Telerik Report Server

To activate the Telerik Report Server:

* When deploying the Report Server on a cloud environment, you may create an Environment Variable named `TELERIK_LICENSE` and add the text content of your Telerik Report Server license key file as a value.
* On a local environment, copy the `telerik-license.txt` license key file to the installation folder of the Telerik Report Server, by default, `C:\Program Files (x86)\Progress\Telerik Report Server\` or any parent folder. This makes the license key available to both the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%}).
* When deploying the Report Server in a cloud environment, create an Environment Variable named `TELERIK_LICENSE` and add the text content of your Telerik Report Server license key file as a value.

* When deploying the Report Server on your local environment, copy the `telerik-license.txt` license key file to the installation folder of the Telerik Report Server or any parent folder. By default, this is `C:\Program Files (x86)\Progress\Telerik Report Server\`. This step makes the license key available to both the [Report Server Manager]({%slug search%}) and [Report Server Agent]({%slug service-agent%}).

To make the license key available to individual Reporting Engine components, copy the file to the following folder:

You may also copy the license key file to the following subfolders, making it available for the corresponding Reporting Engine:

* for __Report Server Manager__, the default folder is `C:\Program Files (x86)\Progress\Telerik Report Server\Telerik.ReportServer.Web\`
* for __Report Server Agent__, the default folder is `C:\Program Files (x86)\Progress\Telerik Report Server\Services\`;
* For __Report Server Manager__, the default folder is `C:\Program Files (x86)\Progress\Telerik Report Server\Telerik.ReportServer.Web\`.
* For __Report Server Agent__, the default folder is `C:\Program Files (x86)\Progress\Telerik Report Server\Services\`.

When you run Telerik Report Server, it automatically locates the license environment variable or license file and activates itself.
When you run Telerik Report Server, it automatically locates the license environment variable or license file and activates the product.

## Updating Your License Key

Whenever you purchase a new license or renew an existing one, always [download](#downloading-the-license-key) and apply the new license key. It includes information about all previous license purchases. This process is referred to as a license key update. Once you have the new license key, use it to [activate Telerik Report Server](#activating-telerik-report-server).
Whenever you purchase a new license or renew an existing one, always [download](#downloading-the-license-key) and apply a new license key. The new license key includes information about all previous license purchases. This process is referred to as a *license key update*. Once you have the new license key, use it to [activate Telerik Report Server](#activating-telerik-report-server).

# See Also

Expand Down