Skip to content

Commit 012097d

Browse files
Refactor Licensing Instructions (#1932)
* Refactor Licensing Instructions * Update setting-up-your-telerik-reporting-license-key.md --------- Co-authored-by: Todor Arabadzhiev <[email protected]>
1 parent 25b9c35 commit 012097d

File tree

4 files changed

+62
-47
lines changed

4 files changed

+62
-47
lines changed
-17.2 KB
Binary file not shown.
7.22 KB
Loading
9.49 KB
Loading
Lines changed: 62 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Setting Up Telerik Reporting License Key
3-
page_title: "Learn how to set up the Telerik Reporting License Key."
2+
title: Setting Up Your License Key
3+
page_title: Setting Up Your License Key
44
description: "Learn how to set up the required Telerik Reporting License Key after the 2025 Q1 (19.0.25.211) release."
55
slug: license-key
66
tags: license, key, telerik, reporting, licensing
@@ -11,89 +11,104 @@ reportingArea: General
1111

1212
# Setting Up Your Telerik Reporting License Key
1313

14-
Starting with the [2025 Q1 (19.0.25.211)](https://www.telerik.com/support/whats-new/reporting/release-history/progress-telerik-reporting-2025-q1-19-0-25-211) release, Telerik Reporting requires activation using a license key — this applies to both the trial and commercial versions of the product. This article describes how to download or update your personal license key and use it to activate the Telerik Reporting product.
14+
Telerik Reporting requires activation through a license key—for both trial and commercial versions of the product. This article describes how to download your personal license key and use it to activate Telerik Reporting.
1515

16-
An invalid license results in [errors and warnings]({%slug license-errors-and-warnings%}) during build and run-time indicators such as watermarks and banners.
16+
An invalid license results in [errors and warnings]({%slug license-errors-and-warnings%}), such as watermarks and banners during build, test, and publish.
1717

18-
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).
18+
> This document applies to Telerik Reporting version [2025 Q1 (19.0.25.211)](https://www.telerik.com/support/whats-new/reporting/release-history/progress-telerik-reporting-2025-q1-19-0-25-211) and later. Earlier versions do not require activation.
1919
20-
## Licensing Dependencies
20+
## Downloading the License Key
2121

22-
Your projects have to reference the package `Telerik.Licensing`. We recommend using the [NuGet Package Manager in Visual Studio](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio). It automatically adds all the required code to your project files.
22+
To download a license key for Telerik Reporting, you must have either a commercial license or a trial license. If you are new to Telerik Reporting, sign up for a [free trial](https://www.telerik.com/try/reporting) first, and then follow the steps below.
2323

24-
>tip We recommend using `Telerik Reporting` NuGet packages in your projects rather than direct assembly references. The main reason is that the packages automatically add all dependencies, whereas when using references, you need to add them manually. The `Telerik.Licensing` package will be added automatically as a dependency for the `Telerik.Reporting` package.
24+
You can use tools that download your license key file [automatically](#downloading-automatically), or you can download it [manually](#downloading-manually).
2525

26-
Here are the changes the Visual Studio NuGet Package Manager will make, depending on the project type:
26+
### Downloading Automatically
2727

28-
### The older .NET Framework project types
28+
The two tools that automatically download your Telerik license key file are the [Progress Control Panel](#using-the-progress-control-panel) and the [Visual Studio extensions](#using-the-visual-studio-extensions) for Telerik Reporting. These tools download and store your license key in your system's home directory. This makes it available for all projects you develop on your local machine.
2929

30-
* Add package reference to the `packages.config` file:
30+
#### Using the Progress Control Panel
3131

32-
````XML
33-
<package id="Telerik.Licensing" version="1.*" targetFramework="net4*" />
34-
````
35-
32+
To install your Telerik License key by using the [Progress Control Panel](https://docs.telerik.com/controlpanel/introduction), start the application. It automatically downloads the `telerik-license.txt` license key file to your home directory:
3633

37-
* Update the `.csproj` file with the DLL reference:
38-
39-
````XML
40-
<Reference Include="Telerik.Licensing.Runtime, Version=1.*, Culture=neutral, PublicKeyToken=*, processorArchitecture=MSIL">
41-
<HintPath>..\..\packages\Telerik.Licensing\lib\net4*\Telerik.Licensing.Runtime.dll</HintPath>
42-
</Reference>
43-
````
34+
* On Windows: `%AppData%\Telerik` or `C:\Users\[windows_username]\%AppData%\Roaming\Telerik`.
35+
* On Mac/Linux: `~/.telerik/`.
4436

37+
#### Using the Visual Studio Extensions
4538

46-
### .NET project types
39+
To install your Telerik License key by using the Visual Studio extensions for Telerik Reporting:
4740

48-
Update the `.csproj` file like below:
41+
1. Open Visual Studio.
4942

50-
````XML
51-
<PackageReference Include="Telerik.Licensing" Version="1.*" />
52-
````
43+
1. Go to **Extensions** > **Telerik** > **Licensing** and select **Download Key**.
5344

54-
We strongly recommend adding the above package for licensing. If adding the package is not an option in your scenario, you may [add a License Key without NuGet References](#adding-a-license-key-to-projects-without-nuget-references).
45+
![Download License Key through Visual Studio Extension for Telerik Reporting.](images/vs-extension-download-key.png)
5546

56-
## Downloading the License Key
47+
The extensions for Telerik Reporting are installed by default when using the MSI installer. If they are missing, you may have used another [installation method]({%slug telerikreporting/installation%}) or deselected them during the setup.
5748

58-
To download a license key for Telerik Reporting, you must have either a developer license or a trial license. If you are new to Telerik Reporting, sign up for a [free trial](https://www.telerik.com/try/reporting) first, and then follow the steps below.
49+
### Downloading Manually
5950

6051
1. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys) page in your Telerik account.
6152
1. Click the **Download License Key** button.
6253

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

65-
>note 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. This makes it available for all projects you develop on your local machine.
56+
1. Copy the [downloaded](#downloading-the-license-key) `telerik-license.txt` license key file to your home directory. This makes the license key available to all projects that you develop on your computer:
6657

67-
You may automatically download and store your license key in your home directory also from the Visual Studio Extensions of Telerik Reporting:
58+
+ For Windows: `%AppData%\Telerik\telerik-license.txt`
59+
+ For Mac/Linux: `~/.telerik/telerik-license.txt`
60+
+ Alternatively, copy the `telerik-license.txt` license key file to the root folder of your project. This makes the license key available only to this project. Do not commit the file to source control as this is your personal license key.
6861

69-
![Download License Key through Visual Studio Extension for Telerik Reporting.](images/vs-extension-download-key.png)
62+
## Activating Telerik Reporting Automatically
7063

71-
## Activating Telerik Reporting
64+
By default, the activation of the Telerik Reporting library is automatic when your license key file is already downloaded and the Visual Studio project has access to `www.nuget.org`.
7265

73-
To activate Telerik Reporting:
66+
If the automatic product activation fails, and you see licensing-related error messages, you need to [activate the product manually](#activating-telerik-reporting-manually).
7467

75-
1. Copy the [downloaded](#downloading-the-license-key) `telerik-license.txt` license key file to your home directory. This makes the license key available to all projects that you develop on your computer.
68+
## Activating Telerik Reporting Manually
7669

77-
+ For Windows: `%AppData%\Telerik\telerik-license.txt`
78-
+ For Mac/Linux: `~/.telerik/telerik-license.txt`
79-
+ Alternatively, copy the `telerik-license.txt` license key file to the root folder of your project. This makes the license key available only to this project. Do not commit the file to source control as this is your personal license key.
70+
If Telerik Reporting cannot be activated automatically:
8071

81-
1. Add the `Telerik.Licensing` package from [NuGet.org](https://www.nuget.org/) as a project dependency: `<PackageReference Include="Telerik.Licensing" Version="1.*" />`
72+
1. Make sure the [license key file](#downloading-the-license-key) is available on your system.
73+
74+
1. Add the `Telerik.Licensing` package from [NuGet.org](https://www.nuget.org/) as a project dependency:
75+
76+
* For **.NET projects**, edit the `.csproj` and add the following line:
77+
78+
````XML
79+
<PackageReference Include="Telerik.Licensing" Version="*" />
80+
````
81+
82+
* For older **.NET Framework projects**:
83+
84+
1. Add package reference to the `packages.config` file:
85+
86+
````XML
87+
<package id="Telerik.Licensing" version="1.*" targetFramework="net4*" />
88+
````
89+
90+
1. Update the `.csproj` file with the DLL reference:
91+
92+
````XML
93+
<Reference Include="Telerik.Licensing.Runtime, Version=1.*, Culture=neutral, PublicKeyToken=*, processorArchitecture=MSIL">
94+
<HintPath>..\..\packages\Telerik.Licensing\lib\net4*\Telerik.Licensing.Runtime.dll</HintPath>
95+
</Reference>
96+
````
8297
83-
When you build the project, the `Telerik.Licensing` NuGet package automatically locates the license file and uses it to activate Telerik Reporting.
98+
When you build the project, the `Telerik.Licensing` NuGet package locates the license file and uses it to activate Telerik Reporting.
8499
85100
> If your project doesn’t use NuGet packages, see [Adding a License Key to Projects without NuGet References](#adding-a-license-key-to-projects-without-nuget-references).
86101
87-
### Adding a License Key to Projects without NuGet References
102+
## Adding a License Key to Projects without NuGet References
88103
89-
Telerik strongly recommends the use of NuGet packages whenever possible. Only include the license key as a code snippet when NuGet packages are not an option.
104+
>caution Telerik strongly recommends the use of the `Telerik.Reporting` NuGet package whenever possible&mdash;it will add all required dependencies, such as `Telerik.Licensing`. Only include the license key as a code snippet (demonstrated in this section) when NuGet packages are not an option.
90105
91106
If you cannot use NuGet packages in your project, add the license as a code snippet:
92107
93108
1. Go to the [License Keys](https://www.telerik.com/account/your-licenses/license-keys) page in your Telerik account.
94-
1. On the Telerik Reporting row, click the __View key__ link in the __SCRIPT KEY__ column.
109+
1. On the Telerik Reporting row, click the __View key__ link in the __SCRIPT KEY__ column.
95110
96-
![Download Product Key](images/download-product-key.png)
111+
![Download Product Key](images/download-script-key.png)
97112
98113
1. Copy the C# code snippet into a new file, for example, `TelerikLicense.cs`.
99114
1. Add the `TelerikLicense.cs` file to your project.
@@ -102,12 +117,12 @@ If you cannot use NuGet packages in your project, add the license as a code snip
102117
103118
## Updating Your License Key
104119
105-
Whenever you purchase a new Telerik Reporting license or renew an existing one, always [download](#downloading-the-license-key) and install 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](#activating-telerik-reporting).
120+
Whenever you purchase a new Telerik Reporting license or renew an existing one, always [download](#downloading-the-license-key) and install 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 Reporting](#activating-telerik-reporting-automatically).
106121
107122
# See Also
108123
109124
* [License Activation Errors and Warnings]({%slug license-errors-and-warnings%})
110-
* [Adding the License Key to CI Services]({%slug license-key-ci-services%}))
125+
* [Adding the License Key to CI Services]({%slug license-key-ci-services%})
111126
* [Frequently Asked Questions about Your Telerik Reporting License Key]({%slug license-frequently-asked-questions%})
112127
* [Upgrading Q1 2025 Trial to Q2 2025 Licensed Version]({%slug upgrade-q1-2025-trial-to-q2-2025-purchase-license%})
113128
* [Licensing before 2025]({%slug telerikreporting/licensing%})

0 commit comments

Comments
 (0)