Licensing

How to license Oxygen XML Web Author.

The Oxygen XML Web Author uses a floating license model, where the license key is stored on a server and individual users consume license seats from a common pool.

How it works

The license key contains the maximum number of users that can simultaneously access the Oxygen XML Web Author at any given moment. After a period of inactivity, the license allocated to that user becomes available.

While no personal information is sent to the server, a cookie that identifies the user is auto-generated. Note that the use of two different browsers (for example, Firefox and Chrome) by a single user, will consume two floating licenses. However, using two or more windows or tabs of the same browser, consumes a single floating license.

Licensing

Follow these steps to license a deployment of the Oxygen XML Web Author:

  1. Install a floating license server. You can deploy the HTTP license server in the same Tomcat server, alongside with Oxygen XML Web Author.
  2. Configure the license server connection.
    Note: Information about your license will be displayed in the About section of the Oxygen XML Web Author Dashboard.

Configuring the License Server Connection

For information on configuring the license server connection with a simple GUI, see Configuring the License Server Connection.

Bundling a default License Server Configuration in the Oxygen XML Web Author

If you need to build the Oxygen XML Web Author with a default license configuration bundled inside, use this method.

The connection to the server should be configured in a file located at WEB-INF/license.properties. It should have the following keys:
licensing.server.type
Type of licensing server. Set it to http.
licensing.server.url
The URL of the license server.
licensing.server.user
The user name used for the license server.
licensing.server.password
The password used for the license server.
licensing.server.encryptedPassword
This is an alternative to licensing.server.password. The value should be the encrypted password.
To encrypt the password, setup the SDK project and run the following command in the oxygen-sample-webapp module:
mvn exec:java -Dexec.mainClass="com.oxygenxml.webapp.EncryptionTool" -Dexec.args="encryptionKey passwd"
where passwd is the password and encriptionKey is the encryption key used to encrypt the password.

A configuration file might look like this:

licensing.server.type=http
licensing.server.url=http://example.com:8080/oxygenLicenseServlet/license-servlet
licensing.server.user=admin
licensing.server.password=******