Volume Counter Instruction Guide


With the introduction of version 3.0.0 of the license key library, we also released a volume based counting mechanism. The mechanism works with an event system. iText and its add-ons will send events through this event system. When a volume license key file has been loaded, the statistics concerning usage will be sent to our servers. This means the machine that runs your application needs an active Internet connection.

This guide will show you how to enable the automated monitoring of volume licenses (Capacity Rental License).

Requirements

  • License Key Library version 3+
    • Core
    • Volume
  • iText 7.1.+
  • Capacity Rental License Key


Configuration of your project

To enable the volume monitoring as required by the Capacity Rental License, you'll need to set up your project to include the license key libraries. For volume counting, you'll need two libraries, the license key core library and the license key volume library. Do make sure that you're always using the latest versions of these dependencies.

You'll need to download two license key dependencies:

  1. itext-licensekey
    This is the license key core library.
  2. itext-licensekey-volume
    This is the plugin built on top of the license key core library to manage volume licenses.


Java

To use the license key libraries we advise you to use Maven or Gradle. You can also download the binaries manually and add them to your classpath.


Maven

To add the volume license key library to your Maven project, you'll need to add our repository to your pom.xml followed by the dependencies.

<repositories>
    <repository>
        <id>central</id>
        <name>iText Repository-releases</name>
        <url>https://repo.itextsupport.com/releases</url>
    </repository>
</repositories>

<dependencies> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itext7-core</artifactId> <version>7.1.0</version> </dependency> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itext-licensekey</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itext-licensekey-volume</artifactId> <version>3.0.0</version> </dependency> </dependencies>


Binaries

You can download the binaries from our hosted repository here:


.NET

To use the license key libraries we advise you to use Nuget. You can also download the binaries manually and add them to your project.


Nuget

To add the libraries to your project, please find them through the Nuget package manager. Searching for the term "itext.licensekey" will bring up the two dependencies in the search result.


Binaries

You can download the binaries from our hosted repository here:

The .dll can be found inside the .nupkg files. You can extract a .nupkg file like a .zip file.


Loading the license file

Loading the license file should be done as soon as possible in the flow of your application. When you load a volume license key, the license key library will set up everything for you, no need to set up any additional counter or logger.

To load the license key file, you'll need to call the following lines of code:


Java

LicenseKey.loadLicenseFile("path/to/itextkey.xml");


.NET

LicenseKey.LoadLicenseFile("path/to/itextkey.xml");