Skip to content

Commit

Permalink
Lisensing (#72)
Browse files Browse the repository at this point in the history 
* New description of licensing

* Review + Java, NodeJS

* URLs changed, aliases added
  • Loading branch information
@Pavel-A-Sokolov
Pavel-A-Sokolov committed Oct 19, 2023
1 parent 1a6924a commit cdfd7d9
Show file tree
Hide file tree
Showing 3 changed files with 172 additions and 104 deletions.
104 changes: 63 additions & 41 deletions java/getting-started/licensing-and-subscription.md
View file
Original file line number Diff line number Diff line change
@@ -1,63 +1,58 @@
---
id: licensing-and-subscription
url: viewer/java/licensing-and-subscription
title: Licensing
id: licensing-and-evaluation
url: viewer/licensing-and-evaluation
title: Licensing and evaluation
weight: 5
keywords: free, free trial, evaluation, groupdocs viewer java
description: "GroupDocs.Viewer for Java provides different plans for purchase or offers a Free Trial and a 30-day Temporary License for evaluation."
productName: GroupDocs.Viewer for Java
hideChildren: False
toc: True
aliases:
- /viewer/java/licensing-and-subscription/
---
Sometimes, in order to study the system better, you want to dive into the code as fast as possible. To make this easier, GroupDocs.Viewer provides different plans for purchase or offers a Free Trial and a 30-day Temporary License for evaluation.

To study the system, you may want quick access to the API. To make this easier, GroupDocs.Viewer provides different plans for purchase and offers a Free Trial and a 30-day Temporary License for evaluation.

{{< alert style="info" >}}

Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the ["Purchase Policies and FAQ"](https://purchase.groupdocs.com/policies) section.
Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the [Purchase Policies and FAQ](https://purchase.groupdocs.com/policies) section.

{{< /alert >}}

## Free Trial or Temporary License

You can try GroupDocs.Viewer without buying a license.

### Free Trial

The evaluation version is the same as the purchased one – the evaluation version simply becomes licensed when you set the license. You can set the license in a number of ways that described in the next sections of this article.

The evaluation version comes with the limitations:

- Only first 2 pages can be rendered.
- Trial badges are placed in the rendering results on the top of each page.

### Temporary License

If you wish to test GroupDocs.Viewer without the limitations of the trial version, you can also request a 30-day Temporary License. For more details, see the ["Get a Temporary License"](https://purchase.groupdocs.com/temporary-license) page.
## Purchased License

## How to set a license
After buying, apply the license file or include it as an embedded resource.

{{< alert style="info" >}}
License needs to be set:
- Only once per application domain
- Before using any other GroupDocs.Viewer classes

### License Applying Options

You can find pricing information at ["Pricing Information"](https://purchase.groupdocs.com/pricing/viewer/java) page.
Licenses can be applied from different locations:

{{< /alert >}}
* Explicit path
* The folder containing the _GroupDocs.Viewer.dll_ file
* The folder containing the assembly that called _GroupDocs.Viewer.dll_
* The folder containing the entry assembly (your _.exe_)
* As a Metered License that allows you to pay for your usage. For details, see the [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered/).

After the license is obtained you need to set the license. This section describes options of how this can be done, and also comments on some common questions.
When you reference _GroupDocs.Viewer.dll_ in the application, the library is copied to your output directory (unless **Copy Local** in the properties for that entry is set to false). The easiest way to set a license is often to place the license file in the same folder as _GroupDocs.Viewer.dll_ and specify just the filename without the path.

The license should be set:
Use the [setLicense](https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/license/#setLicense-java.io.InputStream-) method to license a component.

- Only once per application domain,
- and before using any other GroupDocs.Viewer classes.
Calling `setLicense` multiple times is not harmful, it simply wastes processor time.

{{< alert style="info" >}}
Calling [setMeteredKey](https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/metered/#setMeteredKey-java.lang.String-java.lang.String-) multiple times is not harmful either but wastes processor time and can accumulate consumption improperly.

The license can be set multiple times per app domain but we recommend doing it once since all calls to `SetLicense` except first will just waste processor time.
#### Apply the License

{{< /alert >}}
After obtaining the license, set it. This section explains how to do this. When developing your application, call the `setLicense` method in your startup code before using the GroupDocs.Viewer classes.

### Set License from File
##### Set a License from a File

The following code sets a license from file.
The following code snippet shows how to set a license from file:

{{< tabs "example1">}}
{{< tab "Java" >}}
Expand All @@ -71,10 +66,9 @@ license.setLicense(licensePath);
{{< /tab >}}
{{< /tabs >}}

##### Set a License from a Stream

### Set License from Stream

The following example shows how to set a license from a stream.
The following code snippet shows how to set a license from a stream:

{{< tabs "example2">}}
{{< tab "Java" >}}
Expand All @@ -90,12 +84,11 @@ try (InputStream fileStream = new FileInputStream(licensePath)) {
{{< /tab >}}
{{< /tabs >}}

#### Apply Metered License

### Set Metered License

You can also set [Metered](https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/metered) license as an alternative to license file. It is a new licensing mechanism that will be used along with existing licensing method. It is useful for the customers who want to be billed based on the usage of the API features. For more details, please refer to [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered) section.
You can set the [Metered](https://reference.groupdocs.com/net/viewer/groupdocs.viewer/metered) license as an alternative to license file. It is useful for the customers who want to be billed based on the usage of the API features. For more details, please refer to [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered).

Following is the sample code demonstrating how to use `Metered` licensing.
The following code snippet shows how to use the metered license:

{{< tabs "example3">}}
{{< tab "Java" >}}
Expand All @@ -119,3 +112,32 @@ System.out.println("Credits consumed: " + creditsConsumed);

{{< /tab >}}
{{< /tabs >}}

### Changing the License File Name

You do not have to name the license file "GroupDocs.Viewer.lic". Feel free to rename it as you prefer, and use that name when setting the license in your application.

### "Cannot find license filename" Exception

When you buy and download a license from the GroupDocs website, the license file is named "GroupDocs.Viewer.lic." Download it using your browser. Sometimes, browsers recognize it as XML and add the .xml extension, making the full file name "GroupDocs.Viewer.lic.XML" on your computer.

If Microsoft Windows is set to hide file extensions (which is the default in most installations), the license file will show as "GroupDocs.Viewer.lic" in Windows Explorer. You might assume this is the actual file name and call the `setLicense` method with "GroupDocs.Viewer.lic", but there is no such file, leading to an exception.

To fix this issue, rename the file to remove the hidden .xml extension. Additionally, we suggest disabling the "Hide extensions" option in Microsoft Windows.

## How to Evaluate GroupDocs.Viewer

You can also try GroupDocs.Viewer without buying a license.

### Free Trial

The evaluation version is identical to the purchased one; it becomes licensed once you set the license. You can set the license using methods described in the following sections of this article.

The evaluation version has the following limitations:

- Rendering is limited to the first 2 pages.
- Trial badges are added to the top of a rendered page.

### Temporary License

If you want to test GroupDocs.Viewer without the limitations of the trial version, request a 30-day Temporary License. For details, see the ["Get a Temporary License"](https://purchase.groupdocs.com/temporary-license) page.
75 changes: 49 additions & 26 deletions net/getting-started/licensing-and-subscription.md
View file
Original file line number Diff line number Diff line change
@@ -1,68 +1,79 @@
---
id: licensing-and-subscription
url: viewer/net/licensing-and-subscription
id: licensing-and-evaluation
url: viewer/net/licensing-and-evaluation
title: Licensing and evaluation
weight: 5
keywords: free, free trial, evaluation, groupdocs.viewer
description: "GroupDocs.Viewer provides different plans for purchasing or offers a Free Trial and a 30-day Temporary License for evaluation."
productName: GroupDocs.Viewer for .NET
hideChildren: False
toc: True
aliases:
- /viewer/net/licensing-and-subscription/
---
To study the system, you may want quick access to the API. To make this easier, GroupDocs.Viewer provides different plans for purchase and offers a Free Trial and a 30-day Temporary License for evaluation.

{{< alert style="info" >}}

Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the ["Purchase Policies and FAQ"](https://purchase.groupdocs.com/policies) section.
Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the [Purchase Policies and FAQ](https://purchase.groupdocs.com/policies) section.

{{< /alert >}}

## How to set a license
## Purchased License

{{< alert style="info" >}}
After buying, apply the license file or include it as an embedded resource.

You can find pricing information at ["Pricing Information"](https://purchase.groupdocs.com/pricing/viewer/net) page.
License needs to be set:
- Only once per application domain
- Before using any other GroupDocs.Viewer classes

### License Applying Options

{{< /alert >}}
Licenses can be applied from different locations:

After the license is obtained you need to set the license. This section describes options of how this can be done, and also comments on some common questions.
* Explicit path
* The folder containing the _GroupDocs.Viewer.dll_ file
* The folder containing the assembly that called _GroupDocs.Viewer.dll_
* The folder containing the entry assembly (your _.exe_)
* As a Metered License that allows you to pay for your usage. For details, see the [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered/).

The license should be set:
When you reference _GroupDocs.Viewer.dll_ in the application, the library is copied to your output directory (unless **Copy Local** in the properties for that entry is set to false). The easiest way to set a license is often to place the license file in the same folder as _GroupDocs.Viewer.dll_ and specify just the filename without the path.

- Only once per application domain,
- and before using any other GroupDocs.Viewer classes.
Use the [SetLicense](https://reference.groupdocs.com/viewer/net/groupdocs.viewer/license/setlicense/) method to license a component.

{{< alert style="info" >}}
Calling `SetLicense` multiple times is not harmful, it simply wastes processor time.

The license can be set multiple times per app domain but we recommend doing it once since all calls to `SetLicense` except first will just waste processor time.
Calling [SetMeteredKey](https://reference.groupdocs.com/viewer/net/groupdocs.viewer/metered/setmeteredkey/) multiple times is not harmful either but wastes processor time and can accumulate consumption improperly.

{{< /alert >}}
#### Apply the License

After obtaining the license, set it. This section explains how to do this. When developing your application, call the `SetLicense` method in your startup code before using the GroupDocs.Viewer classes.

### Set a license from a file
##### Set a License from a File

The following code snippet shows how to set a license from file:

{{< tabs "example1">}}
{{< tab "C#" >}}

```csharp
string licensePath = "path to the .lic file";
string licensePath = "GroupDocs.Viewer.lic";
License license = new License();
license.SetLicense(licensePath);
```

{{< /tab >}}
{{< /tabs >}}

### Set a license from a stream
##### Set a License from a Stream

The following code snippet shows how to set a license from a stream.
The following code snippet shows how to set a license from a stream:

{{< tabs "example2">}}
{{< tab "C#" >}}

```csharp
string licensePath = "path to the .lic file";
string licensePath = "GroupDocs.Viewer.lic";
using (FileStream fileStream = File.OpenRead(licensePath))
{
License license = new License();
Expand All @@ -73,11 +84,11 @@ using (FileStream fileStream = File.OpenRead(licensePath))
{{< /tab >}}
{{< /tabs >}}

### Set the metered license
#### Apply Metered License

You can also set [Metered](https://reference.groupdocs.com/net/viewer/groupdocs.viewer/metered) license as an alternative to license file. It is a new licensing mechanism that will be used along with existing licensing method. It is useful for the customers who want to be billed based on the usage of the API features. For more details, please refer to [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered) section.
You can set the [Metered](https://reference.groupdocs.com/net/viewer/groupdocs.viewer/metered) license as an alternative to license file. It is useful for the customers who want to be billed based on the usage of the API features. For more details, please refer to [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered).

The following code snippet shows how to use the metered license.
The following code snippet shows how to use the metered license:

{{< tabs "example3">}}
{{< tab "C#" >}}
Expand All @@ -99,20 +110,32 @@ Console.WriteLine("Credits consumed: " + creditsConsumed);
{{< /tab >}}
{{< /tabs >}}

## How to evaluate GroupDocs.Viewer
### Changing the License File Name

You do not have to name the license file "GroupDocs.Viewer.lic". Feel free to rename it as you prefer, and use that name when setting the license in your application.

### "Cannot find license filename" Exception

When you buy and download a license from the GroupDocs website, the license file is named "GroupDocs.Viewer.lic." Download it using your browser. Sometimes, browsers recognize it as XML and add the .xml extension, making the full file name "GroupDocs.Viewer.lic.XML" on your computer.

If Microsoft Windows is set to hide file extensions (which is the default in most installations), the license file will show as "GroupDocs.Viewer.lic" in Windows Explorer. You might assume this is the actual file name and call the `SetLicense` method with "GroupDocs.Viewer.lic", but there is no such file, leading to an exception.

To fix this issue, rename the file to remove the hidden .xml extension. Additionally, we suggest disabling the "Hide extensions" option in Microsoft Windows.

## How to Evaluate GroupDocs.Viewer

You can also try GroupDocs.Viewer without buying a license.

### Free trial
### Free Trial

The evaluation version is identical to the purchased one; it becomes licensed once you set the license. You can set the license using methods described in the following sections of this article.

The evaluation version has the following limitations:

- Rendering is limited to the first 2 pages.
- Trial badges are added to the top of each rendered page.
- Trial badges are added to the top of a rendered page.

### Temporary license
### Temporary License

If you want to test GroupDocs.Viewer without the limitations of the trial version, request a 30-day Temporary License. For details, see the ["Get a Temporary License"](https://purchase.groupdocs.com/temporary-license) page.

Loading

0 comments on commit cdfd7d9

Please sign in to comment.