History | Edit

The Oxygen XML Web Author functionality that is common with the standalone distribution of Oxygen XML Editor/Author share the same options. This allows you to configure a consistent editing experience for all users.

Author Mode Options

Oxygen XML Web Author stores its options in an options.xml file. The file is located in the options folder of the Oxygen Data Directory.

If you are using the Oxygen XML SDK project, the bundle-options/oxygen-options/options.xml file is bundled with your resulting application and used to provide default options. This file is copied in the Oxygen Data Directory when the application starts if an options.xml file is not already present there.

There are multiple ways to configure these options:

Web Author-Specific Options

A small number of options are specific only to Oxygen XML Web Author and they can be configured in the WEB-INF/web.xml file. Each option is specified as a context-param element.

The following is a list of these options and their accepted values:
Option name Value Default Value Description
com.oxygenxml.loadBuiltinProtocolHandlers true/false True Controls whether or not the built-in handlers for HTTP/HTTPS and FTP/SFTP protocols are installed. Default value is true.
com.oxygenxml.webapp.datastore.docs.memory.size An integer number 10,000 Indicates the number of editing sessions stored in memory.
com.oxygenxml.webapp.datastore.docs.memory.expire Duration (*) 2d Indicates the delay after which inactive sessions are stored on disk.
com.oxygenxml.webapp.datastore.docs.disk.size An integer number 1,000,000 Indicates the number of inactive editing sessions that can be stored on disk.
com.oxygenxml.webapp.datastore.docs.disk.expire Duration (*) 30d Indicates the delay after which inactive sessions are discarded.
com.oxygenxml.validation.threads.no An integer number Half the number of cores on the server Configures the number of validation threads.

(*) - Duration is represented by an integer, followed by "d", "h", "m", or "s", representing days, hours, minutes, or seconds, respectively.

Example:

Here is an example of how to configure a context parameter:
<context-param>
  <param-name>com.oxygenxml.loadBuiltinProtocolHandlers</param-name>
  <param-value>false</param-value>
</context-param>