How to Setup a Load-Balanced Server

To scale a deployment to a larger number of users and to increase the availability, Oxygen XML Web Author can be deployed on a set of load-balanced servers. This topic describes the required setup for such a scenario.

Configure Session Stickyness

Every Oxygen XML Web Author server keeps the state of the edited documents in memory for performance reasons. This implies that every user should connect to the same back-end server for the duration of an editing session. To achieve this result in a load-balanced setting, you should enable session stickyness.

Configure Server Health Checks

To detect unhealthy servers, Oxygen XML Web Author offers a health check REST API. The endpoint has the following interface:

URL: rest-public/status
Response status code: 200 for a healthy server and 503 for an unhealthy server.
Response body: For an unhealthy server, the response body contains a text description of the problem.