Edit online

Installing Oxygen XML on Windows

System Requirements

Operating Systems
CPU
Memory
Storage
Java

Windows Installer

To install Oxygen XML 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 using one of the following methods:
    • Use one of the shortcuts created by the installer.
    • Run oxygen.batoxygenAuthor.batoxygenDeveloper.batoxygenJSONEditor.batsyncroSVNClient.bat, which is located in the installation directory.
  6. To license your copy of Oxygen XML, 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 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 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 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 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[user_home_directory]\AppData\Roaming\com.oxygenxml.author[user_home_directory]\AppData\Roaming\com.oxygenxml.developer[user_home_directory]\AppData\Roaming\com.oxygenxml.jsoneditor).
downloadResources
Used to download resources (links to video demonstrations, webinars, and upcoming events) from 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[user_home_directory]\AppData\Roaming\com.oxygenxml.author[user_home_directory]\AppData\Roaming\com.oxygenxml.developer[user_home_directory]\AppData\Roaming\com.oxygenxml.jsoneditor).
reportProblem
Used to report a problem encountered while using Oxygen XML. 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:

Windows Installer response.varfile

The Oxygen XML 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.
checkNotifications
Used to control checking for application-related news and events. Possible values are true (default) or false.
downloadResources
Used to download resources (links to video demonstrations, webinars, and upcoming events) from to populate the application welcome screen. Possible values are true (default) or false.
reportProblem
Used to report a problem encountered while using Oxygen XML. Possible values are true (default) or false.
installAddons
Set to false to prohibit the application from allowing the end user to install add-ons.
installAIPositronAddons
Set to false to prohibit the application from allowing the end user to install any of the AI Positron Assistant add-ons.