Integrating oXygen

This tutorial is part of the Getting Started Section. It describes how to access BaseX from the oXygen XML Editor. Currently, there are two variants how to use BaseX in oXygen:

• Resources in databases can be opened and modified.
• XPath/XQuery expressions can be run by the query processor of BaseX.

Access Database Resources

1. Start the WebDAV service first, which will allow you to access all resources via the client/server architecture.

• Choose File → Open URL....
  

File:Webdav-oxygen01.png

• Enter the corresponding user name and password (if needed), the URL of the BaseX WebDAV Server, and then click "Browse".
  

Perform Queries

Prerequisites

1. oXygen XML Editor: http://www.oxygenxml.com/
2. BaseX distribution with all libraries included: http://basex.org/download

Data Source

1. Start oXygen and go to Options → Preferences → Data Sources.
2. Add a new Data Source with the New button.
3. Enter "BaseX" as name and choose XQuery API for Java (XQJ) as type.
4. Add the three following JAR files with the Add Button:
   basex.jar, basex-api.jar and xqj-api.jar
5. Now press OK, and your Data Source is ready for use.

Connection

1. Now press New in the Connection Panel (located in Data Sources).
2. Enter Name "BaseXConnection" and select "BaseX" in the Data Source box.
3. Now press OK, and your connection is ready.

Usage

The query execution works as follows:

1. Configure a new transformation scenario in Window → Show View → Transformation Scenarios.
2. Press the plus sign to add a new scenario.
3. Enter a Name, XML URL (your xml file or leave it empty) and the XQuery URL (your query file).
4. Choose "BaseXConnection" in the combo box.
5. Press OK, and your scenario is ready. Now you can start the transformation.
6. The results should immediately occur in the result panel.