Installing Oxygen XML Author on Windows

System Requirements

Operating Systems

The product has been fully tested on Windows versions 10 and 11. The latest version of Oxygen XML Author might work on other versions of Windows, but they have not been officially tested.

CPU

Minimum - Intel/AMD Dual-core class CPU, 2 GHz
Recommended - Quad-core class processor

Memory

Minimum - 3 GB of RAM
Recommended - 8 GB of RAM

Storage

Minimum - 1 GB free disk space
Recommended - 2 GB free disk space

Java

Oxygen XML Author only officially supports Java Virtual Machines with version 17 from Oracle or Eclipse Adoptium. If you use the native Windows installer, Oxygen XML Author will be installed with its own copy of Java with the specific update version that has been thoroughly tested.

All Platforms Package

If you use the all platforms package, your system must have a compatible Java 17 virtual machine installed. To see the exact Java update version that is supported, go to www.oxygenxml.com, navigate to the Download page for the particular product you are installing, and click on the tab for your particular platform.

Note: Oxygen XML Author may work with other versions of Java, but since Oxygen XML Author has only been thoroughly tested with specific versions, there is no guarantee that it will be stable with any other Java version.

Oxygen XML Author uses the following rules to determine which installed version of Java to use:

If you install using the native Windows installer, which installs a version of Java as part of the Oxygen XML Author installation, the version in the jre subdirectory of the installation directory is used.
Otherwise, if the Windows environment variable JAVA_HOME is set, Oxygen XML Author uses the Java version pointed to by this variable.
Otherwise, the version of Java pointed to by your PATH environment variable is used.

If you run Oxygen XML Author using the batch file, oxygenAuthor.bat, you can edit the batch file to specify a particular version to use.

Windows Installer

To install Oxygen XML Author using the Windows installer, follow these steps:

Make sure that your system meets the system requirements.
Download the Windows installer.
[Optional] Validate the integrity of the downloaded file by checking it against the MD5 sum published on the download page.
Run the installer and follow the instructions in the installation program.
Start Oxygen XML Author using one of the following methods:
- Use one of the shortcuts created by the installer.
- Run oxygenAuthor.bat, which is located in the installation directory.
To license your copy of Oxygen XML Author, go to Help > Register and enter your license information.

Windows Unattended Installation

You can run the installation in unattended mode by running the installer from the command line with the -q parameter. By default, running the installer in unattended mode installs Oxygen XML Author with the default options and does not overwrite existing files. You can change various options for the unattended installer using the installer command-line parameters.

Windows Installer Command-Line Reference

The Oxygen XML Author installer for Windows supports a variety of command-line parameters:

-q: Instructs the installer to run in unattended mode. The installer will not prompt the user for input during the install. Default settings will be used for all options unless a response.varfile is specified using the -varfile option.
-overwrite: In unattended mode, the installer does not overwrite files with the same name if a previous version of the Oxygen XML Author is installed in the same folder. The -overwrite parameter added after the -q parameter forces the overwriting of these files.
-console: Displays a console during an unattended installation.
Note: If you want the installer to run in the foreground, you need to use the start /wait command (for example, start /wait oxygen.exe -q -console). Otherwise, it will run in the background.
-varfile: Specifies the location of a response.varfile, normally to be used during an unattended installation.
-c: Allows users to configure the installation by inputting answers to installation questions in the command line.
Tip: Using this parameter is the best way to use the installer for people who are visually impaired.
-V[variable name]=[variable value]: This command-line parameter can be used to define any of the variables listed below to be used by an installation.

EXAMPLE:

oxygen.exe -q -overwrite -console -VautoVersionChecking=false

Command-Line Variables for Preconfiguring License Server Details

For organizations that use a license server to manage user licenses, the Oxygen XML Author installer also supports the following command-line variables used for preconfiguring license server details:

autoVersionChecking: Used for automatic version checking. Possible values are true (default) or false.
backup.license.servlet.url: Specifies the URL of the backup HTTP license server.
backup.license.servlet.user.name: Specifies the user name for the backup HTTP license server.
backup.license.servlet.password: Specifies the password for the backup HTTP license server, in clear form (will be stored encrypted).
backup.license.servlet.password.encrypted: Specifies the password for the HTTP license server, in encrypted form. Can be obtained from an entry with the same name in an existing license.xml file (found in: [user_home_directory]\AppData\Roaming\com.oxygenxml.author).
downloadResources: Used to download resources (links to video demonstrations, webinars, and upcoming events) from https://www.oxygenxml.com to populate the application welcome screen. Possible values are true (default) or false.
license.servlet.url: Specifies the URL of the HTTP license server.
license.servlet.user.name: Specifies the user name for the HTTP license server.
license.servlet.password: Specifies the password for the HTTP license server, in clear form (will be stored encrypted).
license.servlet.password.encrypted: Specifies the password for the HTTP license server, in encrypted form. Can be obtained from an entry with the same name in an existing license.xml file (found in: [user_home_directory]\AppData\Roaming\com.oxygenxml.author).
reportProblem: Used to report a problem encountered while using Oxygen XML Author. Possible values are true (default) or false.

EXAMPLE:

oxygen.exe "-Vlicense.servlet.url=http://main.licenseserver:8080/oXygenLicenseServlet/license-servlet"
 "-Vlicense.servlet.user.name=user" "-Vlicense.servlet.password=mypass" 
 "-Vbackup.license.servlet.url=http://backup.licenseserver:8080/oXygenLicenseServlet/license-servlet"
 "-Vbackup.license.servlet.user.name=user" "-Vbackup.license.servlet.password=mypass"

Note: For information about deploying and registering floating licenses for multiple users, see Registering Floating Licenses for Multiple Users.

Windows Installer response.varfile

The Oxygen XML Author installer for Windows also creates a file called response.varfile, which records the choices that the user made when running the installer interactively. The generated response file is found in the [OXYGEN_INSTALL_DIR]/.install4j folder. You can use the response.varfile to set the options for an unintended install. For more information about the response.varfile format, see install4j site.

Variables (can be used in the response.varfile or from the command line)

The following variables are supported in the response.varfile (or from the command line):

autoVersionChecking: Used for automatic version checking. Possible values are true (default) or false.
downloadResources: Used to download resources (links to video demonstrations, webinars, and upcoming events) from https://www.oxygenxml.com to populate the application welcome screen. Possible values are true (default) or false.
reportProblem: Used to report a problem encountered while using Oxygen XML Author. Possible values are true (default) or false.