Customizing Options

The Oxygen XML WebApp Component functionality is common with the standalone distribution of Oxygen XML Editor, as they share the same options. This allows you to configure a consistent editing experience for all users.

Author Mode Options

You can modify the options in the Oxygen XML Editor standalone application and then export them as an XML file by clicking the Options > Export Global Options menu action. The exported options file should replace the options.xml file from bundle-options/oxygen-options/ folder in the oXygen XML SDK project.

WebApp Configuration File

A small number of options are specific only to the Oxygen XML WebApp Component 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 options and their accepted values:
Option name Value Description
com.oxygenxml.loadBuiltinProtocolHandlers true/false 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. Indicates the number of editing sessions stored in memory.
com.oxygenxml.webapp.datastore.docs.memory.expire Duration (*) Indicates the delay after which inactive sessions are stored on disk.
com.oxygenxml.webapp.datastore.docs.disk.size An integer number. Indicates the number of inactive editing sessions that can be stored on disk.
com.oxygenxml.webapp.datastore.docs.disk.expire Duration (*) Indicates the delay after which inactive sessions are discarded.

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

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>