Licensing

How it works

The license key contains the maximum number of users that can simultaneously access the Oxygen XML Web Author Component 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 Component:

1. . You can deploy the HTTP license server in the same Tomcat server, alongside with Oxygen XML Web Author Component.
2. Configure the license server connection.

   Note

   Information about your license will be displayed in the About section of the Oxygen XML Web Author Component 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 Component

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

The connection to the server should be configured in a properties file located in WEB-INF/license.properties. This file might look like this:

licensing.server.type=http
licensing.server.url=http://example.com:8080/oxygenLicenseServlet/license-servlet
licensing.server.user=<USER>
licensing.server.password=<CHANGE-ME>

The following keys are supported:

licensing.server.type

Type of licensing server. Set it to http.

licensing.server.url

The URL of the license server.

licensing.server.user

The name of the user with role user used to connect to 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.

backup.licensing.server.url

(optional) For some of the licensing packages we offer a backup license key that can be deployed on a second license server in order to provide higher availability in presence of machine and network failures. This key contains the URL of this backup license server.

backup.licensing.server.user

(optional) The name of the user with role user used to connect to the backup license server.

backup.licensing.server.password

(optional) The password to use for the backup license server.

backup.licensing.server.encryptedPassword

(optional) This is an alternative to backup.licensing.server.password. In order to generate its value, see the instructions for licensing.server.encryptedPassword.