Customizing Options
The Oxygen XML Web Author Component functionality that is common with the standalone distribution of Oxygen XML Author share the same options. This allows you to configure a consistent editing experience for all users.
Author Mode Options
Oxygen XML Web Author Component stores its options in an options.xml
file.
If you are using the oXygen XML SDK project, the file is located in the
bundle-options/oxygen-options/ folder and will be bundled with the
web application. If you are using one of the installation kits, it is located in the
options folder of the Oxygen Data
Directory.
There are multiple ways to configure these options:
- Some of the options can be changed using the Administration Page in your web browser.
- Use an options file exported from Oxygen XML Author standalone application. To export the file, use the menu action.
- Manually edit the options file. To learn more about the supported options and the file format, see Oxygen XML Author Options Supported by Oxygen XML Web Author Component.
Oxygen XML Web Author Component specific options
A small number of options are specific only to the Oxygen XML Web Author 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. |
com.oxygenxml.validation.threads.no |
An integer number | Configures the number of validation threads. |
(*) - 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>