Licensing and evaluation Leave feedback

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

Note

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 section.

After buying, apply the license file or include it as an embedded resource.

License needs to be set:

• Only once per application domain and only once for each GroupDocs product you want to use
• Before using any other GroupDocs.Total classes

Licenses can be applied from different locations:

• Explicit path
• The folder containing the groupdocs-total.jar file
• The folder containing the package that called groupdocs-total.jar
• The folder containing the entry package (your .jar)
• As a Metered License that allows you to pay for your usage. For details, see the Metered Licensing FAQ.
• As an embedded resource When you reference groupdocs-total.jar in the application, the library is copied to your output directory. The easiest way to set a license is often to place the license file in the same folder as groupdocs-total.jar and specify just the filename without the path.

Use the setLicense method to license a specific GroupDocs product. For example, to apply license for GroupDocs.Viewer component setLicense method has to be used.

Calling setLicense multiple times is not harmful, it simply wastes processor time.

Calling setMeteredKey multiple times is not harmful either but wastes processor time and can accumulate consumption improperly.

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.Total classes.

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

string licensePath = "GroupDocs.Total.lic";
com.groupdocs.viewer.License licenseViewer = new com.groupdocs.viewer.License();
licenseViewer.setLicense(licensePath);

com.groupdocs.conversion.License licenseConversion = new com.groupdocs.conversion.License();
licenseConversion.setLicense(licensePath);

// Set licenses for other GroupDocs products you are going to use

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

try (InputStream fileStream = new FileInputStream("GroupDocs.Total.lic")) {
    com.groupdocs.viewer.License licenseViewer = new com.groupdocs.viewer.License();
    licenseViewer.setLicense(licenseStream);

    com.groupdocs.conversion.License licenseConversion = new com.groupdocs.conversion.License();
    licenseConversion.setLicense(licenseStream);

    // Set licenses for other GroupDocs products you are going to use
}

You can set the 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.

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

string publicKey = ""; // Your public license key
string privateKey = ""; // Your private license key

// Set metered keys for GroupDocs.Viewer
com.groupdocs.viewer.Metered meteredViewer = new com.groupdocs.viewer.Metered();
meteredViewer.SetMeteredKey(publicKey, privateKey);

// Get amount (MB) consumed
decimal amountConsumed = com.groupdocs.viewer.Metered.getConsumptionQuantity();
System.out.println("Amount (MB) consumed: " + amountConsumed);

// Get count of credits consumed
decimal creditsConsumed = com.groupdocs.viewer.Metered.getConsumptionCredit();
System.out.println("Credits consumed: " + creditsConsumed);

// Set metered keys for GroupDocs.Conversion
com.groupdocs.conversion.Metered meteredConversion = new com.groupdocs.conversion.Metered();
meteredConversion.setMeteredKey(publicKey, privateKey);

Instead of using a license file, you can install the license as an embedded resource. To do this, add a license to the project and specify the license name in the setLicense method without specifying the full path to this file.

Note

To use the embedded license, add it to your project and set the Build Action property of this file to “Embedded Resource”. Ensure that the license name in the embedded resources matches the string parameter of the setLicense method.

The following code snippet shows how to use the embedded license:

com.groupdocs.viewer.License licenseViewer = new com.groupdocs.viewer.License();
licenseViewer.setLicense("GroupDocs.Total.lic");

com.groupdocs.conversion.License licenseConversion = new com.groupdocs.conversion.License();
licenseConversion.setLicense("GroupDocs.Total.lic");

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

When you buy and download a license from the GroupDocs website, the license file is named “GroupDocs.Total.lic.” Download it using your browser. Sometimes, browsers recognize it as XML and add the .xml extension, making the full file name “GroupDocs.Total.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.Total.lic” in Windows Explorer. You might assume this is the actual file name and call the setLicense method with “GroupDocs.Total.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.

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

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.

If you want to test GroupDocs.Total without the limitations of the trial version, request a 30-day Temporary License. For details, see the “Get a Temporary License” page.