Edit online

Configuring Options

The shares the same options as the standalone distribution of Oxygen XML Editor/Author for various functionality that is common to both products. This allows you to configure a consistent editing experience for all users.

Important:

Whenever you change options for , it is recommended that you restart the server to ensure the changes get applied.

Author Mode Options

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 Web Author Component integration project, zip the options.xml file and save it in the src/main/weapp/WEB-INF directory. During the deployment, this file is copied in the Oxygen Data Directory if an options.xml file is not already present there.

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 an Oxygen standalone application. To export the file, use the Options > Export Global Options menu action.
Note:
Archived options are unpackaged to the options folder only if an options.xml file is not already present.
Manually edit the options file. To learn more about the supported options and the file format, continue reading the section below.

Oxygen Standalone Options Supported by Web Author

supports some of the options used by Oxygen XML Editor/Author. The supported options are applied for all Web Author users.

Web Author-Specific Options

supports some additional options that can be configured using the options.xml file.


Option name	Type	Description
ADMIN_PAGE_IS_DISABLED	Boolean	Set value to `true` to disable the Administration Page completely.
WEBAPP_SHOW_ADMIN_PAGE_LINK	Boolean	Set value to `true` to display the admin page link on the dashboard.
WEBAPP_ALLOW_EDIT_PROFILING_ATTRIBUTES	String	Set value to `true` to always show the "Edit Profiling Attributes" contextual menu action, `false` to never show it, and `auto` to show it only for DITA XML maps and topics. By default, the value is `auto`.
force.cookies.samesite.none	Boolean	Set value to `true` to force cookies to be set with the `SameSite=None` attribute and the `Secure` attribute for cases where it is unavoidable to serve on a hostname that is different from the parent web application.
ime_interface	String	Set value to `EditContext` to support Sougou Chinese IME on Chrome and Safari.
validate.frameworks	Boolean	Set value to `false` to deactivate the framework validation option that appears in the Administration page for uploading frameworks. The default value is `true`.

Example: The options.xml file would look like this:

<entry> 
  <String>force.cookies.samesite.none</String>
  <Boolean>true</Boolean>
</entry>

Other Web Author Configurations

A small number of configurations, specific only to , can be configured in the WEB-INF/web.xml file. Each configuration is specified as a <context-param> element.

The following is a list of these configurations and their accepted values:


Key	Value	Default Value	Description
com.oxygenxml.loadBuiltinProtocolHandlers	Boolean	True	Controls whether or not the built-in handlers for HTTP/HTTPS and SFTP protocols are installed. Default value is true.
com.oxygenxml.validation.threads.no	An integer number	Half the number of cores on the server	Configures the number of validation threads.

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>

Custom Options for the Git Plugin

It is possible to configure a master account for the Git connector so that users do not have to log in to edit documents. The following options can be set in the options.xml file.


Option name	Value	Description
PLUGIN_CUSTOM_OPTIONS.git.enforced_user	string	The master account username.
PLUGIN_CUSTOM_OPTIONS.git.enforced_pass	string	The master account password.
PLUGIN_CUSTOM_OPTIONS.git.enforced_mail	string	The master account address.
PLUGIN_CUSTOM_OPTIONS.github.size_in_megabytes_for_a_read_file	string	The maximum allowed size for uploaded images (default value is 50M).

Example: The options.xml file would contain the following snippet:

<entry>
  <String>PLUGIN_CUSTOM_OPTIONS.git.enforced_user</String>
  <String>example_username</String>
</entry>
<entry>
  <String>PLUGIN_CUSTOM_OPTIONS.git.enforced_pass</String>
  <String>example_password</String>
</entry>
<entry>
  <String>PLUGIN_CUSTOM_OPTIONS.git.enforced_mail</String>
  <String>mail@example.com</String>
</entry>
<entry>
  <String>PLUGIN_CUSTOM_OPTIONS.github.size_in_megabytes_for_a_read_file</String>
  <String>20</String>
</entry>

Custom Options for the AI Positron Assistant Plugin

It is possible to configure options for the Oxygen AI Positron Assistant Enterprise for Web Author plugin. The following option can be set in the options.xml file.


Option name	Value	Description
PLUGIN_CUSTOM_OPTIONS.oxygen.positron.plugin.connection.read.timeout	string	Controls the read timeout (in seconds) for the AI Positron service connection (default value is 600).

Custom Options for the SharePoint Plugin

If your documents use absolute URLs to reference other resources (such as images or DITA conrefs), considers them as external and does not use the current user account to retrieve them. As a result, they may not be displayed in the editor. To fix this problem, you need to set the following option in the options.xml file. If you use SharePoint Online, this option is not necessary.


Option name	Value	Description
PLUGIN_CUSTOM_OPTIONS.sharepoint_domain_name	string	The domain name of the SharePoint installation.

Example: The options.xml file would look like this:

<entry> 
  <String>PLUGIN_CUSTOM_OPTIONS.sharepoint_domain_name</String>
  <String>sharepoint.my-company.com</String>
</entry>

Custom Options for the Outline Plugin


Option name	Value	Description
PLUGIN_CUSTOM_OPTIONS.outlinePlacement	string	Specifies which side of the interface that the Outline pane is placed. Accepted values are: left or right.

Custom Options for Content Security Policy (CSP)


Option name	Value	Description
use_csp_header	Boolean	Set to `true` to use the `Content-Security-Policy` header. This is recommended for enhanced security.
csp_use_custom_policy	Boolean	Set to `true` to customize the value of the `Content-Security-Policy` header.
You can contribute to each directive of the Content Security Policy using the following options: csp.default.src csp.script.src csp.style.src csp.img.src csp.connect.src csp.font.src csp.object.src csp.media.src csp.frame.src csp.sandbox	String Array	Specify an array of strings that will be appended the value of the CSP directive. Attention: These options are only taken into account if the value of `csp_use_custom_policy` is true. Tip: For more information about the CSP directives, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy#directives.

Example: The options.xml file would contain the following snippet:

<entry> 	
  <String>use_csp_header</String> 	
  <Boolean>true</Boolean> </entry>
<entry> 	
  <String>csp_use_custom_policy</String> 	
  <Boolean>true</Boolean> </entry>
<entry> 	
  <String>csp.default.src</String> 	
  <String-array> 		
    <String>'self'</String> 		
    <String>https://www.oxygenxml.com</String> 	
  </String-array>
 </entry>

Impose a Set of Options Using a Plugin

A set of sample plugins can be found at https://github.com/oxygenxml/web-author-sample-plugins. It contains a JavaScript-based sample plugin called web-author-impose-options that provides an example of how you can impose a set of options for .