Oxygen XML Web Author

https://www.oxygenxml.com/doc/versions/27.1.0/
Admin
Oxygen XML Web Author is a browser-based XML editing and authoring solution that enables...
Tokens:375,906
Snippets:2,043
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Oxygen XML Web Author Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-bitbucket-server-integration

This guide covers the initial installation process for Oxygen XML Web Author, detailing the prerequisites and steps required for a successful setup.

```documentation
Installation
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation.html
```

--------------------------------

### Installation Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-integrate-webdav-plugin

A comprehensive guide to installing Oxygen XML Web Author. This covers prerequisites, installation steps, and initial configuration.

```APIDOC
APIDOC:
  Topic: Installation
  URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation.html
  Description: Step-by-step instructions for the initial installation of Oxygen XML Web Author.
```

--------------------------------

### Oxygen XML Web Author Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-integrate-perforce

This documentation provides instructions for the initial installation of Oxygen XML Web Author. It covers the prerequisites and steps for a successful setup.

```APIDOC
Installation:
  This documentation provides detailed instructions for the initial installation of Oxygen XML Web Author.
  It covers system requirements and the step-by-step installation process.
```

--------------------------------

### Oxygen XML Web Author Installation Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-websphere-liberty-tutorial

This documentation details the initial installation process for Oxygen XML Web Author.

```APIDOC
Topic: Installation
URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation.html
Description: Steps for the initial installation of Oxygen XML Web Author.
```

--------------------------------

### Oxygen XML Web Author Installation Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-reset-admin-credentials

This guide provides detailed instructions for installing Oxygen XML Web Author. It covers prerequisites, installation steps, and initial configuration.

```APIDOC
Deployment and Administration:
  Installation
    - Purpose: To guide users through the installation process of Oxygen XML Web Author.
    - Prerequisites: System requirements, Java Development Kit (JDK), and application server details.
    - Steps: Includes downloading the installer, running the setup, and initial configuration.
    - Related Topics: Deployment and Administration, Licensing, Upgrading.
```

--------------------------------

### Install WebSphere Liberty Components

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-websphere-liberty-tutorial

Command to install all required components for the default server using installUtility.

```bash
bin\installUtility install defaultServer
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation

Guides on deploying and managing Oxygen XML Web Author, including installation, memory allocation, starting/stopping, HTTPS, licensing, and upgrades.

```APIDOC
APIDOC:
  Topic: webapp-initial-installation.html
  Description: Describes the initial installation process for Oxygen XML Web Author.

  Topic: webauthor-increase-memory.html
  Description: Details how to increase the memory allocated to Oxygen XML Web Author.

  Topic: webauthor-restart.html
  Description: Instructions for starting and stopping Oxygen XML Web Author.

  Topic: wa_https_doc.html
  Description: Configuration guide for HTTPS support in Oxygen XML Web Author.

  Topic: webapp_licensing.html
  Description: Information regarding the licensing of Oxygen XML Web Author.

  Topic: Update_procedure.html
  Description: Procedures for upgrading Oxygen XML Web Author to newer versions.
```

--------------------------------

### Deployment and Administration Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/saxon_extension_functions

Provides instructions on deploying and managing Oxygen XML Web Author in various environments. Covers server setup, configuration, and administrative tasks.

```Documentation
Deployment and Administration:
  - Server installation and configuration
  - User management and access control
  - Monitoring and maintenance procedures.
```

--------------------------------

### Deployment and Administration Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/web-author-custom-connection-to-a-file-server

Describes the process of deploying and managing Oxygen XML Web Author, covering server setup, configuration, and administrative tasks.

```URL
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa_https_doc

Guides on deploying and managing Oxygen XML Web Author, including initial installation, memory allocation, starting/stopping the application, and licensing.

```APIDOC
Deployment and Administration:
  Describes how to deploy and manage Oxygen XML Web Author.

Installation:
  Covers the initial setup of Oxygen XML Web Author.

Increasing the Memory Allocated to Oxygen XML Web Author:
  Details how to increase the memory available to the application.

Starting and Stopping Oxygen XML Web Author:
  Provides instructions for managing the application's lifecycle.

Licensing:
  Information regarding the licensing of Oxygen XML Web Author.

Upgrading:
  Procedure for updating Oxygen XML Web Author to a newer version.

Deploying Web Author in WebSphere Liberty:
  Tutorial for deploying the application in a WebSphere Liberty environment.

Deploying Web Author in WildFly (Deprecated):
  Instructions for deploying in WildFly, noting it is deprecated.

Deploying Web Author in a Docker Container:
  Guide for deploying Oxygen XML Web Author using Docker.

Redundancy/Backup Deployments:
  Information on setting up redundant or backup deployment configurations.

Web Author Oxygen Data Directory:
  Details about the data directory used by Oxygen XML Web Author.

Administration Page:
  Information on accessing and using the administration interface.

Integrating Web Author with a File Storage Service:
  How to integrate with external file storage solutions.

Integrating Web Author with AI Positron Assistant Enterprise:
  Steps for integrating with the AI Positron Assistant Enterprise.

Setting up a Load-Balanced Server:
  Guidance on configuring a load-balanced server environment.

Security Manager:
  Information on configuring and using the Security Manager.

Security Hardening:
  Best practices for securing Oxygen XML Web Author.

Sharing a Tomcat Instance (not recommended):
  Discussion on sharing a Tomcat instance, with a recommendation against it.

Using an IIS Reverse Proxy:
  Instructions for setting up an IIS reverse proxy for Web Author.

Locating and Configuring Logs:
  Guidance on finding and configuring application logs.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom

Guides on deploying and managing Oxygen XML Web Author, including server setup and user administration.

```Documentation
[Deployment and Administration](https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html)
Describes how to deploy and manage Oxygen XML Web Author
```

--------------------------------

### Start WebSphere Liberty Server

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-websphere-liberty-tutorial

Command to start the WebSphere Liberty server with a clean state.

```bash
bin\server start --clean
```

--------------------------------

### Oxygen XML Web Author Plugin Development Setup

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-plugin-best-practices

Guides on setting up the development environment for Oxygen XML Web Author plugins, including IDE configuration and prototyping.

```APIDOC
webapp-plugin-prototyping.html:
  - Steps for setting up a local development environment.
  - Tools and configurations for plugin prototyping.
  - Version control recommendations.
```

```APIDOC
web-author-js-api-ide.html:
  - Configuring JavaScript IDEs for Oxygen XML Web Author plugin development.
  - Setting up code completion and debugging.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-loadbalancing

Guides on deploying and managing Oxygen XML Web Author, covering installation, licensing, upgrading, and various deployment scenarios.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.
  - Covers installation, licensing, and upgrading procedures.
  - Includes deployment guides for WebSphere Liberty, WildFly (Deprecated), and Docker containers.
  - Details redundancy/backup deployments and managing the Oxygen Data Directory.
  - Information on the Administration Page and integrating with file storage services.
  - Security hardening, reverse proxy configurations (IIS), log management, and handling confidential data.
  - Support for Cross-Domain Cookies and IPv6.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-add-framework

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and various server configurations.

```APIDOC
Deployment and Administration:
  Describes how to deploy and manage Oxygen XML Web Author.

  Installation:
    Details the initial installation process.

  Licensing:
    Information on licensing the Web Author.

  Upgrading:
    Procedure for upgrading an existing installation.

  Deploying Web Author in WebSphere Liberty:
    Tutorial for deploying in WebSphere Liberty.

  Deploying Web Author in WildFly (Deprecated):
    Tutorial for deploying in WildFly (note: deprecated).

  Deploying Web Author in a Docker Container:
    Instructions for deploying within a Docker container.

  Redundancy/Backup Deployments:
    Guidance on setting up redundant or backup deployments.

  Web Author Oxygen Data Directory:
    Information about the Web Author's data directory.

  Setting up a Load-Balanced Server:
    Instructions for configuring a load-balanced server environment.

  Security Manager:
    Information on using the Security Manager.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-restart

Guides on deploying and managing Oxygen XML Web Author, including installation, starting/stopping, memory configuration, HTTPS, and various server environments.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.

Installation:
  - Covers the initial installation process.

Starting and Stopping Oxygen XML Web Author:
  - Details on how to start and stop the application.

Increasing the Memory Allocated to Oxygen XML Web Author:
  - Instructions for increasing the JVM memory allocated to the application.

HTTPS Support:
  - Guidance on configuring HTTPS for secure communication.

Licensing:
  - Information regarding the licensing of Oxygen XML Web Author.

Upgrading:
  - Procedures for updating to newer versions.

Deploying Web Author in WebSphere Liberty:
  - Specific instructions for deploying in a WebSphere Liberty environment.

Deploying Web Author in WildFly (Deprecated):
  - Instructions for deploying in WildFly, noting it is deprecated.

Deploying Web Author in a Docker Container:
  - Steps for deploying the application using Docker.

Redundancy/Backup Deployments:
  - Strategies for setting up redundant or backup instances.

Web Author Oxygen Data Directory:
  - Explanation of the Oxygen Data Directory and its management.

Administration Page:
  - Information about accessing and using the administration interface.

Integrating Web Author with a File Storage Service:
  - Guidance on connecting with external file storage solutions.

Integrating Web Author with AI Positron Assistant Enterprise:
  - Instructions for integrating with the AI Positron Assistant Enterprise.

Setting up a Load-Balanced Server:
  - Configuration details for load balancing.

Security Manager:
  - Information on configuring and using the Security Manager.

Security Hardening:
  - Best practices for securing the Web Author instance.

Sharing a Tomcat Instance (not recommended):
  - Guidance on sharing a Tomcat instance, with a warning against it.

Using an IIS Reverse Proxy:
  - Instructions for setting up an IIS reverse proxy.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-integrate-github-plugin

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and various server deployments.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.
  - Includes sections on:
    - Installation
    - Licensing
    - Upgrading
    - Deploying Web Author in WebSphere Liberty
    - Deploying Web Author in WildFly (Deprecated)
    - Deploying Web Author in a Docker Container
    - Redundancy/Backup Deployments
    - Web Author Oxygen Data Directory
    - Administration Page
```

--------------------------------

### Install Oxygen XML Web Author Test Server Add-on

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon

Instructions for installing the Oxygen XML Web Author Test Server add-on. This can be done by dragging and dropping a link into the Oxygen editing area or by manually installing it through the Help > Install new add-ons menu.

```English
To manually install this add-on in a standalone installation of **Oxygen XML Editor/Author** , follow this procedure:
  1. Go to Help > Install new add-ons to open an add-on selection dialog box. Enter or paste **https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml** in the Show add-ons from field or select it from the drop-down menu.
  2. Select the **Oxygen XML Web Author Test Server** add-on and click Next.
```

--------------------------------

### Deploying Oxygen XML Web Author

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-integrate-ai-positron-enterprise

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and specific server configurations like WebSphere Liberty, WildFly, and Docker.

```APIDOC
Deployment and Administration:
  Describes how to deploy and manage Oxygen XML Web Author.

  Installation:
    Details the initial installation process.

  Licensing:
    Information on licensing Oxygen XML Web Author.

  Upgrading:
    Procedure for upgrading an existing installation.

  Deploying Web Author in WebSphere Liberty:
    Specific instructions for deploying in WebSphere Liberty.

  Deploying Web Author in WildFly (Deprecated):
    Instructions for deploying in WildFly (note: deprecated).

  Deploying Web Author in a Docker Container:
    Guide for deploying within a Docker container.

  Redundancy/Backup Deployments:
    Information on setting up redundant or backup deployments.

  Web Author Oxygen Data Directory:
    Details about the Oxygen Data Directory.

  Administration Page:
    Information on accessing and using the administration page.

  Integrating Web Author with a File Storage Service:
    Guidance on integrating with file storage services.

  Integrating Web Author with AI Positron Assistant Enterprise:
    Instructions for integrating with AI Positron Assistant Enterprise.

  Setting up a Load-Balanced Server:
    Steps for configuring a load-balanced server setup.

  Security Manager:
    Information on the Security Manager.

  Security Hardening:
    Guidance on hardening the security of Web Author.

  Sharing a Tomcat Instance (not recommended):
    Information on sharing a Tomcat instance, with a recommendation against it.

  Using an IIS Reverse Proxy:
    Instructions for using an IIS reverse proxy.

  Locating and Configuring Logs:
    Details on finding and configuring logs.

  Handling of Confidential Data:
    Information on handling confidential data.

  Cross-Domain Cookies:
    Details on cross-domain cookies (SameSite=None).

  IPv6 Support:
    Information on IPv6 support for Web Author.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-oxygen-data-dir

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and various server configurations.

```APIDOC
Deployment and Administration:
  - Installation: Describes the initial setup process.
  - Licensing: Information on obtaining and applying licenses.
  - Upgrading: Procedures for updating to newer versions.
  - Deploying Web Author in WebSphere Liberty: Specific instructions for this application server.
  - Deploying Web Author in WildFly (Deprecated): Instructions for WildFly, noted as deprecated.
  - Deploying Web Author in a Docker Container: Steps for containerized deployment.
  - Redundancy/Backup Deployments: Strategies for high availability and data backup.
  - Web Author Oxygen Data Directory: Details on the data directory configuration.
  - Administration Page: Accessing and using the administration interface.
  - Setting up a Load-Balanced Server: Configuring for high traffic and availability.
  - Sharing a Tomcat Instance (not recommended): Guidance on sharing Tomcat, with a warning.
  - Using an IIS Reverse Proxy: Configuration for using IIS as a reverse proxy.
  - Locating and Configuring Logs: How to find and set up logging for troubleshooting.
  - Handling of Confidential Data: Procedures for managing sensitive information.
  - Cross-Domain Cookies: Configuration related to cookie behavior across domains.
  - IPv6 Support: Information on enabling and using IPv6.
  - How to Enable the Rate Limit Filter: Steps to activate rate limiting for security and performance.
```

--------------------------------

### Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-predefined-frameworks

Information on deploying and administering Oxygen XML Web Author, including setup, management, and troubleshooting common issues.

```APIDOC
Deployment and Administration: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
Troubleshooting: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-technical-issues.html
```

--------------------------------

### Deployment and Administration of Oxygen XML Web Author

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/customizing_frameworks

This guide covers the essential aspects of deploying and administering Oxygen XML Web Author in various environments. It includes setup, configuration, and management best practices.

```APIDOC
Deployment and Administration:
  - Details the procedures for installing and configuring Oxygen XML Web Author.
  - Covers server setup, user management, and operational administration tasks.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-login-admin-active-directory

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and various deployment scenarios like Docker and application servers.

```APIDOC
Deployment and Administration:
  - Installation
  - Licensing
  - Upgrading
  - Deploying Web Author in WebSphere Liberty
  - Deploying Web Author in WildFly (Deprecated)
  - Deploying Web Author in a Docker Container
  - Redundancy/Backup Deployments
  - Web Author Oxygen Data Directory
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/WA-websocket

Guides on deploying and managing Oxygen XML Web Author, covering installation, licensing, upgrades, and various deployment scenarios including Docker, WebSphere Liberty, and WildFly. It also details redundancy, load balancing, and security configurations.

```APIDOC
Deployment and Administration:
  - Installation: Initial setup procedures for Oxygen XML Web Author.
  - Licensing: Information on obtaining and managing licenses.
  - Upgrading: Steps for updating to newer versions.
  - Deploying Web Author in WebSphere Liberty: Specific instructions for deploying on WebSphere Liberty.
  - Deploying Web Author in WildFly (Deprecated): Instructions for WildFly deployment (noted as deprecated).
  - Deploying Web Author in a Docker Container: Guidance on containerizing Web Author.
  - Redundancy/Backup Deployments: Strategies for high availability and backups.
  - Web Author Oxygen Data Directory: Explanation of the data directory's role and management.
  - Administration Page: Accessing and using the administrative interface.
  - Integrating Web Author with a File Storage Service: Connecting to external file storage.
  - Integrating Web Author with AI Positron Assistant Enterprise: Integration with AI services.
  - Setting up a Load-Balanced Server: Configuring for load balancing.
  - Security Manager: Details on the security manager.
  - Security Hardening: Best practices for securing the application.
  - Sharing a Tomcat Instance (not recommended): Warnings and guidance on sharing Tomcat.
  - Using an IIS Reverse Proxy: Configuration for IIS as a reverse proxy.
  - Locating and Configuring Logs: How to find and set up logging.
  - Handling of Confidential Data: Procedures for managing sensitive information.
```

--------------------------------

### Creating Frameworks From Scratch

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa--cc-customization-example1

Provides a step-by-step guide on how to create a new framework from scratch for Oxygen XML Web Author.

```APIDOC
Creating Frameworks From Scratch:
  URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-create-framework-from-scratch.html
```

--------------------------------

### Troubleshooting Protocol Handler Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-browser-out-of-memory

Addresses issues encountered during the installation of protocol handlers for Oxygen XML Web Author. This section provides guidance on resolving problems with protocol handler setup.

```English
Protocol Handlers Cannot Be Installed: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers.html
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-security-configuration

Guides users on how to deploy and manage Oxygen XML Web Author. This section covers initial installation, licensing, upgrading, and specific deployment procedures for different application servers and container environments.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.
  - Covers initial installation, licensing, and upgrading procedures.
  - Includes deployment guides for WebSphere Liberty, WildFly (Deprecated), and Docker containers.
  - Details redundancy/backup deployments and the Web Author Oxygen Data Directory.
  - Explains setting up a load-balanced server and configuring the Security Manager.
```

--------------------------------

### Troubleshooting Protocol Handlers Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers

This section addresses issues where protocol handlers cannot be installed for Oxygen XML Web Author. It provides guidance on diagnosing and resolving problems related to the setup and functionality of custom protocol handlers.

```documentation
Protocol Handlers Cannot Be Installed
This section addresses issues where protocol handlers cannot be installed for Oxygen XML Web Author. It provides guidance on diagnosing and resolving problems related to the setup and functionality of custom protocol handlers.
```

--------------------------------

### Creating Frameworks from Scratch

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-file-templates

Provides a step-by-step guide on creating a new framework from the ground up for Oxygen XML Web Author.

```APIDOC
Topic: How to Create a Framework From Scratch
URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-create-framework-from-scratch.html
```

--------------------------------

### Creating Frameworks From Scratch

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa--annotations-cc

A step-by-step guide on how to create a new framework from scratch for Oxygen XML Web Author, covering all essential aspects.

```URL
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-create-framework-from-scratch.html
```

--------------------------------

### VM Options Example

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-increase-memory

Example of how to specify memory allocation in the oXygenXmlWebAuthor.vmoptions file.

```java
-Xmx4g
```

--------------------------------

### Deployment and Administration Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/glossary/framework

Provides instructions on deploying and managing Oxygen XML Web Author. This covers the necessary steps for setting up and maintaining the application in a production environment.

```APIDOC
Deployment and Administration:
  Description: Describes how to deploy and manage Oxygen XML Web Author
  URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
```

--------------------------------

### Example: Configure Content Completion to Insert XML Structure

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa--annotations-cc

This example demonstrates how to configure the Content Completion Assistant to insert specific XML structures. It serves as a practical guide for implementing custom content insertion.

```APIDOC
Example: Configure Content Completion to Insert a Certain XML Structure:
  - Illustrates a practical scenario for content completion.
  - Focuses on inserting predefined XML structures.
  - Related to Content Completion Assistant customization.
```

--------------------------------

### Headless Installation Command

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation

This command initiates a silent or unattended installation of Oxygen XML Web Author, useful for automated deployments. The '-c' flag indicates a command-line installation.

```bash
C:\\oxygenxml-web-author-64bit.exe -c
```

--------------------------------

### Example OXY-URL for GitHub File

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/oxy-url

An example of an OXY-URL pointing to a DITA topic file within a GitHub repository.

```APIDOC
gitgh://https%3A%2F%2Fgithub.com%2Foxygenxml%2Fug/master/DITA/topics/introduction.dita
```

--------------------------------

### WildFly Deployment Steps

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-wildfly-tutorial

Steps to deploy Oxygen XML Web Author in WildFly, including user creation and server startup.

```APIDOC
1. Download WildFly version 16.0.0.Final from http://wildfly.org/downloads/.
2. Extract the WildFly archive.
3. Navigate to the wildfly/bin directory in the command line.
4. Run add-user.bat (or add-user.sh for Linux) to create a Management User and an Application User.
   - For the Application User, when prompted for groups, enter: "admin"
5. Start the WildFly server using standalone.bat (or standalone.sh) with the system property: -Dee8.preview.mode=true
   Example: ./standalone.sh -Dee8.preview.mode=true
6. Access the WildFly console at http://localhost:9990/console/index.html.
7. Under Deployments, select 'Deploy an Application' > 'Start'.
8. Upload the Web Author WAR file.
```

--------------------------------

### Install fontconfig Package

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-publishing-support

Command to install the required 'fontconfig' package on Debian-based systems for the Web Author Publishing plugin.

```bash
sudo apt-get install font-config
```

--------------------------------

### Deployment, Administration, and Troubleshooting

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-customizing-templates

Details on deploying and managing Oxygen XML Web Author, comparing different product distributions (Web Author vs. Web Author Component, Web Author vs. Content Fusion), and a compilation of troubleshooting topics for common problems.

```English
Deployment and Administration
Web Author vs. Web Author Component
Web Author vs. Content Fusion
Troubleshooting
```

--------------------------------

### Troubleshooting Protocol Handler Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-csrf

This section addresses issues with installing protocol handlers for Oxygen XML Web Author.

```English
Protocol Handlers Cannot Be Installed
Guidance on resolving protocol handler installation failures.
```

--------------------------------

### Deployment and Administration Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-plugins

Provides instructions on deploying and managing Oxygen XML Web Author in a server environment. Covers essential administration tasks for a smooth operation.

```Shell
Deployment and Administration:
  - Server deployment steps
  - Configuration management
  - User and access control
```

--------------------------------

### Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/WA-dita-map-tree-structure-editable

This guide covers the deployment and administration of Oxygen XML Web Author, including installation, configuration, and maintenance.

```APIDOC
Deployment and Administration:
  - Installation procedures for various server environments.
  - Configuration of Web Author settings, including security and performance.
  - User management, license management, and monitoring.
```

--------------------------------

### Oxygen XML Web Author Comparisons and Troubleshooting

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon

Provides comparisons between different Oxygen XML products (Web Author, Editor/Author, Content Fusion) and a collection of troubleshooting topics for common issues.

```Reference
Feature Matrix
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/applet_webapp_comparison.html
```

```Reference
Web Author vs. Web Author Component
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-product-vs-sdk.html
```

```Reference
Web Author vs. Content Fusion
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/content-fusion_vs_web-author.html
```

```Reference
Troubleshooting
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-technical-issues.html
```

```Reference
FAQ for Customizations
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-faq-customizations.html
```

--------------------------------

### Deployment and Administration Guide

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/glossary/ditamap

Information on deploying and managing Oxygen XML Web Author. This section covers the necessary steps for setting up and administering the application.

```APIDOC
URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
Description: Describes how to deploy and manage Oxygen XML Web Author
```

--------------------------------

### Protocol Handlers Cannot Be Installed

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-troubleshooting

Guidance for troubleshooting issues related to the installation of protocol handlers in Oxygen XML Web Author.

```English
Protocol Handlers Cannot Be Installed
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers.html
```

--------------------------------

### Troubleshooting Protocol Handler Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/text-invisible

Offers guidance on resolving issues with installing protocol handlers in Oxygen XML Web Author.

```English
Protocol Handlers Cannot Be Installed
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers.html
```

--------------------------------

### Troubleshooting Protocol Handler Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-custom-plugin-problems

Covers issues encountered during the installation of protocol handlers for Oxygen XML Web Author. This section helps resolve problems that prevent protocol handlers from being installed correctly.

```APIDOC
Topic: Protocol Handlers Cannot Be Installed
URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers.html
Description: Offers solutions for failures in installing custom protocol handlers required for specific functionalities.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-framework-java-extension

Guides on deploying and managing Oxygen XML Web Author, including feature comparisons and troubleshooting common problems.

```English
Deployment and Administration
Feature Matrix
Web Author vs. Web Author Component
Web Author vs. Content Fusion
Troubleshooting
```

--------------------------------

### Starting and Stopping Oxygen XML Web Author

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-increase-memory

Procedures for starting and stopping the Oxygen XML Web Author application, essential for maintenance and updates.

```APIDOC
Starting and Stopping Oxygen XML Web Author:
  - Provides commands or steps to initiate and terminate the Web Author service.
  - Necessary for application lifecycle management.
```

--------------------------------

### Oxygen XML Web Author Comparisons and Troubleshooting

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-framework-plugins

Provides comparisons between different Oxygen XML products (Web Author, Editor/Author, Content Fusion) and a collection of troubleshooting topics for common problems.

```Documentation
Feature Matrix
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/applet_webapp_comparison.html
```

```Documentation
Web Author vs. Web Author Component
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-product-vs-sdk.html
```

```Documentation
Web Author vs. Content Fusion
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/content-fusion_vs_web-author.html
```

```Documentation
Troubleshooting
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-technical-issues.html
```

```Documentation
FAQ for Customizations
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-faq-customizations.html
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon

Guides on deploying and managing Oxygen XML Web Author, including information on the test server add-on and general administration practices.

```Administration
Deployment and Administration
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
```

```Administration
Oxygen XML Web Author Test Server Add-on
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon.html
```

--------------------------------

### Troubleshooting Protocol Handler Installation

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-stuck-server

This topic provides solutions for issues encountered when trying to install protocol handlers for Oxygen XML Web Author.

```APIDOC
Topic: Protocol Handlers Cannot Be Installed
URL: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-troubleshoot-protocol-handlers.html
Description: Helps users resolve problems related to the installation or functionality of custom protocol handlers used by Oxygen XML Web Author.
```

--------------------------------

### Troubleshooting Invisible Text on Linux Installer

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/text-invisible

Addresses an issue where text on buttons and labels is invisible when using the Linux installer for Oxygen XML Web Author.

```English
Text on Buttons and Labels is Invisible for Linux Installer
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/text-invisible.html
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_editor_variables

Guides on deploying and managing Oxygen XML Web Author, including information on the test server add-on and general deployment strategies.

```Markdown
* [Deployment and Administration](https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html)
* [Oxygen XML Web Author Test Server Add-on](https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon.html)
```

--------------------------------

### Oxygen XML Web Author Deployment and Troubleshooting

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-framework-customization-script

Guides on deploying and administering Oxygen XML Web Author, along with troubleshooting common issues and a glossary of terms.

```English
Deployment and Administration
Troubleshooting
Glossary
```

--------------------------------

### CMIS Connector Server URL Examples

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-integrate-CMIS

Examples of server URLs for connecting Oxygen XML Web Author to different CMIS-compliant content management systems.

```APIDOC
Server URL Examples:
  * Alfresco: http://[host]:[port]/alfresco/api/-default-/public/cmis/versions/1.1/atom
  * SharePoint On-Premise: http://[host]/_vti_bin/cmis/rest?getRepositories
  * SharePoint On-Premise (specific repository): http://[host]/_vti_bin/cmis/rest/REPOSITORY_ID?getRepositoryinfo
  * FileNet: http://[host]:[port]/fncmis/resources/Service
```

--------------------------------

### Deployment, Administration, and Troubleshooting

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/WA-dita-topic-doc-type

Covers the deployment and administration of Oxygen XML Web Author, along with troubleshooting common issues and a FAQ for customizations.

```APIDOC
Deployment and Administration
Troubleshooting
FAQ for Customizations
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-framework-plugins

Guides on deploying and managing Oxygen XML Web Author, including information on the test server add-on and general administration tasks.

```Administration
Deployment and Administration
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
```

```Administration
Oxygen XML Web Author Test Server Add-on
https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon.html
```

--------------------------------

### Install Custom Filter - Java

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-faq-customizations

Demonstrates how to install a custom AuthorDocumentFilter by implementing WorkspaceAccessPluginExtension and adding a WebappEditingSessionLifecycleListener. This filter intercepts content changes to manage document content.

```Java
public class CustomFilterInstaller implements WorkspaceAccessPluginExtension {
  @Override
  public void applicationStarted(StandalonePluginWorkspace pluginWorkspaceAccess) {
    WebappPluginWorkspace pluginWorkspace = (WebappPluginWorkspace)PluginWorkspaceProvider.getPluginWorkspace();
      pluginWorkspace.addEditingSessionLifecycleListener(new WebappEditingSessionLifecycleListener() {
        @Override
        public void editingSessionStarted(String sessionId, AuthorDocumentModel documentModel) {
          documentModel.getAuthorDocumentController().setDocumentFilter(new CustomAuthorDocumentFilter(documentModel));
        }
      });
  }
}
```

--------------------------------

### Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-plugin-best-practices

Provides instructions on deploying and administering Oxygen XML Web Author. This covers server setup, configuration, and management for production environments.

```APIDOC
Deployment and Administration:
  - Server installation and configuration
  - User management and access control
  - Performance tuning and monitoring
  - Integration with other systems.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-increase-memory

Guides on deploying and managing Oxygen XML Web Author, covering installation, upgrades, and various server configurations.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.
  - Installation: Covers initial setup procedures.
  - Upgrading: Provides guidance on updating the software.
  - Deploying Web Author in WebSphere Liberty: Specific instructions for this application server.
  - Deploying Web Author in WildFly (Deprecated): Instructions for WildFly deployment.
  - Deploying Web Author in a Docker Container: Steps for containerized deployment.
  - Redundancy/Backup Deployments: Strategies for high availability.
  - Web Author Oxygen Data Directory: Information on the data directory.
  - Administration Page: Accessing and using the administration interface.
  - Integrating Web Author with a File Storage Service: Connecting to external storage.
  - Integrating Web Author with AI Positron Assistant Enterprise: Integration with AI services.
  - Setting up a Load-Balanced Server: Configuring for high traffic.
  - Security Manager: Configuration related to the security manager.
  - Security Hardening: Best practices for securing the application.
  - Sharing a Tomcat Instance (not recommended): Guidance on shared Tomcat setups.
  - Using an IIS Reverse Proxy: Configuration for IIS as a reverse proxy.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-synchronizing-with-server

Describes how to deploy and manage Oxygen XML Web Author, including server setup and administrative tasks.

```English
Deployment and Administration
```

--------------------------------

### Oxygen XML Web Author Deployment Environments

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp-initial-installation

Instructions for deploying Oxygen XML Web Author in specific server environments and containerization.

```APIDOC
APIDOC:
  Topic: wa-websphere-liberty-tutorial.html
  Description: Tutorial for deploying Oxygen XML Web Author in WebSphere Liberty.

  Topic: wa-wildfly-tutorial.html
  Description: Tutorial for deploying Oxygen XML Web Author in WildFly (Deprecated).

  Topic: web-author-docker.html
  Description: Guide for deploying Oxygen XML Web Author in a Docker container.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/web-author-logs

Guides on deploying and managing Oxygen XML Web Author, including installation, licensing, upgrading, and various server configurations.

```APIDOC
Deployment and Administration:
  - Installation: Covers the initial setup of Oxygen XML Web Author.
  - Licensing: Information on how to license the product.
  - Upgrading: Procedures for updating to newer versions.
  - Deploying Web Author in WebSphere Liberty: Specific instructions for deploying on WebSphere Liberty.
  - Deploying Web Author in WildFly (Deprecated): Instructions for WildFly deployment (note: deprecated).
  - Deploying Web Author in a Docker Container: Guidance on containerizing the application.
  - Redundancy/Backup Deployments: Strategies for high availability and backups.
  - Web Author Oxygen Data Directory: Details on the data directory structure and management.
  - Administration Page: Information about the web-based administration interface.
  - Integrating Web Author with a File Storage Service: How to connect with external file storage.
  - Integrating Web Author with AI Positron Assistant Enterprise: Steps for integrating with an AI assistant.
  - Setting up a Load-Balanced Server: Configuration for load balancing.
  - Security Manager: Details on the security manager.
  - Security Hardening: Best practices for securing the deployment.
  - Sharing a Tomcat Instance (not recommended): Information on sharing Tomcat, with a warning.
  - Using an IIS Reverse Proxy: Configuration for using IIS as a reverse proxy.
  - Locating and Configuring Logs: How to find and set up logging.
  - Handling of Confidential Data: Guidelines for managing sensitive information.
  - Cross-Domain Cookies: Configuration for cross-domain cookie behavior.
  - IPv6 Support: Information on enabling IPv6.
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-map-inline-actions

Guides on deploying and managing Oxygen XML Web Author, including information on the test server add-on and activating extra features.

```Deployment
Deployment and Administration: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webapp_deployment.html
Oxygen XML Web Author Test Server Add-on: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-test-server-addon.html
Activating Extra Features: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-activating-extra-features.html
```

--------------------------------

### Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-unit-test-framework

Provides instructions on deploying and managing Oxygen XML Web Author. This section covers server setup, configuration, and administrative tasks.

```APIDOC
Deployment and Administration:
  - Server deployment options
  - Configuration settings for Web Author
  - User management and access control
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-create-framework-from-scratch

Information on deploying and managing Oxygen XML Web Author, including feature comparisons and troubleshooting.

```English
Deployment and Administration
Feature Matrix
Web Author vs. Web Author Component
Web Author vs. Content Fusion
Troubleshooting
```

--------------------------------

### Oxygen XML Web Author Deployment and Administration

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/wa-admin-page-auth

Guides users through the process of deploying and managing Oxygen XML Web Author. This includes initial installation, licensing, and upgrading procedures.

```APIDOC
Deployment and Administration:
  - Describes how to deploy and manage Oxygen XML Web Author.
  - Includes topics on:
    - Installation
    - Licensing
    - Upgrading
    - Deploying Web Author in WebSphere Liberty
    - Deploying Web Author in WildFly (Deprecated)
    - Deploying Web Author in a Docker Container
    - Redundancy/Backup Deployments
    - Web Author Oxygen Data Directory
```

--------------------------------

### System Property Examples

Source: https://www.oxygenxml.com/doc/versions/27.1.0/ug-waCustom/topics/webauthor-set-system-property

Examples of Java system properties that can be set to configure Oxygen XML Web Author, such as controlling memory allocation and specifying the data directory.

```APIDOC
Examples:
- Control memory allocation: `-D<option_name>=<option_value>` (e.g., `-Xmx1024m`)
- Change Oxygen Data Directory: `-Doxygen.data.dir=<path_to_directory>`
```
Tokens:
Raw