Obtaining and installing an <oXygen/> license

<oXygen/> is not free software and requires a license in order to enable the application.

For demonstration and evaluation purposes a time limited license is available upon request from the <oXygen/> Web Site. This license is supplied at no cost for a period of 30 days from date of issue. During this period <oXygen/> is fully functional enabling you to test all aspects of the application. Thereafter, the application is disabled and a permanent license must be purchased in order to use the application. For special circumstances, if a trial period of greater than 30 days is required, please contact . All licenses are obtained from <oXygen/> Web Site.

For definitions and legal details of the license types available for <oXygen/> you should consult the End User License Agreement received with the license key and available also on the <oXygen/> website at http://www.oxygenxml.com/eula.html

Note

Starting with version 7.1 <oXygen/> accepts a license key for a newer version in the license registration dialog, e.g. version 7.1 accepts a license key for version 8.0.

Once you have obtained a license the installation procedure is described below.

Named User license installation

  1. Save a backup copy of the message containing the new license key.

  2. Start the <oXygen/> application.

  3. Copy to the clipboard the license text as explained in the message.

  4. If there is a new install of the editor then it will display automatically the registration dialog when it is started. In the case you already used the editor and obtained a new license, go to Window - Preferences - oXygen and press the Register button to make the registration dialog appear.

    Figure 2.1. Registration Dialog

    Registration Dialog

  5. Paste the license text in the registration dialog, and press Register.

You have the following alternative for the procedure of license install:

Procedure 2.4. Save the license in a text file

  1. Save the license key in a file named licensekey.txt.

  2. Copy the file in the 'lib' folder of the installed plugin. In that way the license will not be asked when <oXygen/> will start.

  3. Start Eclipse.

How floating (concurrent) licenses work

If all the floating licenses are used in the same local network the installation procedure of floating licenses is the same as for the Named User licenses. Within the same network the license management is done by communication between the instances of <oXygen/> that are connected to the same local network and that run at the same time. Any new instance of <oXygen/> that is started after the number of running instances is equal with the number of purchased licenses will display a warning message and will disable the open file action.

If the floating licenses are used on machines connected to different local networks a separate license server must be started and the licenses deployed on it. Contact the <oXygen/> Support Team at to request the license server kit.

Procedure 2.5. Floating license server setup

  1. Contact the <oXygen/> Support Team at to request the license server kit.

  2. Install the license server in a directory on your server.

  3. You have to configure the server to look into a license directory (by default is [Server License Install Directory]/licenses) and use a certain TCP/IP port for communication (by default port 12346 is used). The license directory will contain the license files to be managed. A license file must begin with "license" and it has to have the extension "txt". It is the job of the license server to sum up the total number of licenses contained in the license files from the licenses directory.

    To change the default configuration of the license server the following parameters have to be used:

    • -licenseDir followed by the path of the directory where the license files will be placed;

    • -port followed by the port number used to communicate with <oXygen/> instances.

After the floating license server is set up the <oXygen/> application can be started and configured to request a license from it:

Procedure 2.6. Request a floating license from the license server

  1. Start <oXygen/>.

  2. Click Help -> Register.... The license dialog is displayed.

  3. Check the Use a license server checkbox.

  4. Fill-in the Host text field with the host name or IP address of the license server.

  5. Fill-in the Port text field with the port number used for communicating with the license server. Default is 12346.

  6. Click the Register button. If the maximum number of available licenses was not exceeded a license key is received from the floating license server and registered in <oXygen/>. If the maximum number of licenses was exceeded a warning dialog will pop up letting the user know about the problem.

    Figure 2.2. Floating license number exceeded

    Floating license number exceeded

    The error message contains information about the users who requested and successfully received the floating licenses.

How to release a floating license

To release a floating license key so that it can be registered for other user you do not have to disable or to uninstall the <oXygen/> plugin. All you have to do is to go to the main <oXygen/> preferences panel, press the Register button, uncheck the use a license server checkbox in the license registration dialog and press OK in the dialog.