Setting up a license key

The open-source Saxon-HE product does not require any license key. For Saxon-PE and Saxon-EE, however, you need to obtain a license key from Saxonica. You can order a free license key for a 30-day evaluation, or purchase an unrestricted license key, from the Saxonica website.

The license key will arrive in the form of a file named saxon-license.lic attached to an email message. Saxon will search for the license key in the following locations:

  1. If you supply a Saxon configuration file, the location given in the licenseFileLocation attribute of the outermost configuration element in this file.

  2. The location specified using the configuration property Feature.LICENSE_FILE_LOCATION, as described below.

  3. The directory containing the executable Saxon software, that is saxon-ee-10.#.jar or saxon-pe-10.#.jar on the Java platform, and saxon-pe-10.#.dll or saxon-ee-10.#.dll on the .NET platform. (On .NET, remember that the software may have been moved to the Global Assembly Cache.)

  4. On the Java platform only, the directories identified by the environment variable SAXON_HOME and SAXON_HOME/bin.

  5. On the .NET platform only, the installation directory - that is, the directory chosen for installing the software when the installation wizard was run. This directory is identified in the Windows registry.

  6. All directories on the Java class path. When running from the command line, you can set the classpath using the -cp option on the java command, or via the environment variable CLASSPATH. More complex environments might have other ways of building the classpath. In Tomcat, for example, the license file should be treated in the same way as free-standing (unjarred) classes, and placed in the WEB-INF/classes directory.

It is also possible to force Saxon to read the license file from a specific location by setting the Configuration property Feature.LICENSE_FILE_LOCATION. When this property is set, the Configuration will immediately attempt to load the specified file, avoiding any subsequent attempt to search for it on the classpath and elsewhere. This mechanism is useful in environments that are otherwise difficult to control: for example configuration properties can be specified as attributes to the factory element of Ant's <xslt> task.

On the Java platform it is generally simplest to copy the file to the directory in which saxon-ee-10.#.jar is installed. On .NET it is generally simplest to copy the file to the directory in which saxon-ee-10.#.dll is installed, and then set the environment variable SAXON_HOME to point to this location.

If you acquire Saxon-PE or Saxon-EE as a component of an application with which it has been integrated, the application may activate the software automatically using an OEM license key. In this case you do not need to acquire an individual license key of your own. This also applies if you want to run transformations or validate using schemas that a developer has issued in compiled form with an embedded license key: in this case you will need to download the Saxon-EE software, but you do not need to install a separate license key.

Please be aware that the terms and conditions under which license files are issued require you to ensure that it is kept confidential and secure, and is used only on one machine. It must not be copied to other computers, or made available for sharing on a file server.