Difference between revisions of "Integrating oXygen"

From BaseX Documentation
Jump to navigation Jump to search
Line 18: Line 18:
 
===Prerequisites===  
 
===Prerequisites===  
  
# oXygen XML Editor: http://www.oxygenxml.com/
 
 
# BaseX distribution with all libraries included: http://basex.org/download
 
# BaseX distribution with all libraries included: http://basex.org/download
 +
# Compatible versions of the three libaries <code>basex.jar</code>, <code>basex-api.jar</code>, and <code>xqj-api.jar</code>
  
 
===Data Source===  
 
===Data Source===  
Line 25: Line 25:
 
# Add a new Data Source with the ''New'' button.  
 
# Add a new Data Source with the ''New'' button.  
 
# Enter "BaseX" as name and choose ''XQuery API for Java (XQJ)'' as type.  
 
# Enter "BaseX" as name and choose ''XQuery API for Java (XQJ)'' as type.  
# Add the three following JAR files with the ''Add'' Button:<br/><code>basex.jar</code>, <code>basex-api.jar</code> and <code>xqj-api.jar</code>
+
# Add the three JAR files above with the ''Add'' Button.
 
# Now press ''OK'', and your Data Source is ready for use.
 
# Now press ''OK'', and your Data Source is ready for use.
  

Revision as of 13:20, 25 October 2011

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:

Access Database Resources

  • Start the WebDAV service first, which will allow you to access all resources via the client/server architecture.
  • Choose FileOpen 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".

File:Oxygen02.png

Perform Queries

Prerequisites

  1. BaseX distribution with all libraries included: http://basex.org/download
  2. Compatible versions of the three libaries basex.jar, basex-api.jar, and xqj-api.jar

Data Source

  1. Start oXygen and go to OptionsPreferencesData 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 JAR files above with the Add Button.
  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 WindowShow ViewTransformation 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.