Installing Oxygen XML Author on Windows

Choosing an Installation Method

You can install Oxygen XML Author on Windows using one of the following methods:

System Requirements

Operating systems

Windows Vista, Windows 7, Windows 8, Windows 10, Windows Server 2008, Windows Server 2012

CPU
  • Minimum - Intel Pentium III™/AMD Athlon™ class processor, 1 GHz
  • Recommended - Dual Core class processor
Memory
  • Minimum - 2 GB of RAM
  • Recommended - 4 GB of RAM
Storage
  • Minimum - 400 MB free disk space
  • Recommended - 1 GB free disk space
Java

Oxygen XML Author requires Java. If you use the native Windows installer, Oxygen XML Author will be installed with its own copy of Java. If you use the all platforms installer, your system must have a compatible Java virtual machine installed.

Oxygen XML Author only supports official and stable Java Virtual Machines with the version number 1.6.0 or later (the recommended version is 1.8) from Oracle available at http://www.oracle.com/technetwork/java/javase/downloads/index.html. Oxygen XML Author may work with JVM implementations from other vendors, but there is no guarantee that those implementations will work with future Oxygen XML Author updates and releases.

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

  1. 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.
  2. Otherwise, if the Windows environment variable JAVA_HOME is set, Oxygen XML Author uses the Java version pointed to by this variable.
  3. 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:
  1. Make sure that your system meets the system requirements.
  2. Download the Windows installer.
  3. [Optional] Validate the integrity of the downloaded file by checking it against the MD5 sum published on the download page.
  4. Run the installer and follow the instructions in the installation program.
  5. 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.
  6. To license your copy of Oxygen XML Author go to Help > Register and enter your license information.

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 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.

The following table describes some of the settings that can be used in the response.varfile:
Table 1. response.varfile Options Parameters
Parameter Name Description Values
autoVersionChecking Automatic version checking. true / false. Default setting is true.
reportProblem Allows you to report a problem encountered while using Oxygen XML Author. true / false. Default setting is true.
downloadResources Allows Oxygen XML Author to download resources (links to video demonstrations, webinars, and upcoming events) from https://www.oxygenxml.com to populate the application welcome screen. true / false. Default setting is true.

For more information about the response.varfile format, see install4j site.

Command Line Parameters
The Oxygen XML Author installer supports the following command line parameters:
Table 2. Supported Parameters
Option Meaning
-q Run the installer 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 or individual settings are specified using
- on Windows:
oxygenAuthor.exe -q 
- on Linux:
oxygenAuthor.sh -q 
-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.
- on Windows:
oxygenAuthor.exe -q -overwrite
- on Linux:
oxygenAuthor.sh -q -overwrite
-console
To display a console for the unattended installation, add a -console parameter to the command line.
- on Windows:
start /wait oxygenAuthor.exe -q -console
Note: The use of start /wait on Windows is required to make the installer run in the foreground. It you run it without start /wait, it will run in the background.
- on Linux:
oxygenAuthor.sh -q -console
-varfile Points to the location of a response.varfile to be used during an unattended installation. For example:
- on Windows:
oxygenAuthor.exe -q -varfile response.varfile
- on Linux:
oxygenAuthor.sh -q -varfile response.varfile
-V Is used to define a variable to be used by an unattended installation. For example:
- on Windows:
oxygenAuthor.exe -q -VusageDataCollector=false
- on Linux:
oxygenAuthor.sh -q -VusageDataCollector=false