Running and Testing the Oxygen XML Web Author Component

Licensing the Oxygen XML Web Author Component

Before running the Oxygen XML Web Author Component, you need to install and configure a floating license server. For more details, please see the User Guide.

Running the Oxygen XML Web Author Component

On a Tomcat Server Configured in the Eclipse IDE

The oxygen-sample-webapp depends on the following modules:

  • bundle-options which specifies the Oxygen options to be used by the Web Author.
  • bundle-frameworks which contains the frameworks that the Web Author will use.
  • bundle-plugins which specifies the Oxygen plugins to be used by the Web Author. The most important one is the oxygen-sample-plugin-custom-protocol which can be modified to access resources from a CMS.
  • bundle-samplefiles samples opened in the Web Author.

To start the sample Web Author Component on a server configured in the Eclipse IDE follow this procedure:

  1. Make sure you select the main project (in our example it is called mySample).

  2. From the contextual menu use Run As -> Maven build... and in the Goals text box enter
    install -pl oxygen-sample-webapp -am
    , then press Run.
  3. Using the contextual menu on the main project, run Maven -> Update Project.... Click OK in the dialog box. This will synchronize the Eclipse project settings with that of the maven pom file.
  4. Using the contextual menu invoke the oxygen-sample-webapp project. Choose Run as... -> Run on server.
  5. Choose the Apache Tomcat v7.0 Server.
  6. Select the option Always use this server when running this project.

    Run Oxygen XML webapp on server

  7. Press Next.
  8. In the wizard page Specify the installation directory, provide the installation folder of the Tomcat server. or if you don't have the server on you machine install it by pressing "Download and Install.." button and following the instructions.


At this point, Eclipse might throw an error that a resource has not been found, thus halting the set-up process. This is due to an issue in the Eclipse-Maven integration. As a workaround, invoke the contextual menu on the oxygen-sample-webapp module, and choose Maven > Disable Workspace Resolution. Repeat step 3 to complete the set-up process.

On a Standalone Tomcat Server Installation

  1. In order to run the web application on a standalone application server (e.g. Tomcat) you first have to build your project .war file.

    To do this, right-click the main project and run Maven install, or directly in the command line invoke the following instruction:

    mvn install

  2. Then you have to deploy the oxygen-sdk-sample-webapp.war file found in the target directory of the oxygen-sample-webapp project, following the deployment procedure specific to your server. You can find deployment instructions for Tomcat 8 here.

  3. In order to access the main page you should access the link /oxygen-sdk-sample-webapp/, relative to the URL of your server.

Please note that the URLs that you provide in the form on the home page must be accessible to the server (for instance, if using the file: protocol then the resources must be on the same file system with the server process and accessible to Tomcat).

Testing the Oxygen XML Web Author Component in the Browser

When you start the application with "Run on server", Eclipse shows the Web Author Dashboard in the internal browser. For the best development experience, we recommend that you open this URL in Chrome.

For information about editing and reviewing documents with Oxygen XML Web Author, see our User Guide.