home -> developer -> SQL -> tutorial -> install -> directory structure

back next

Directory structure

Open the Waterken/ folder that you just installed. The folder contains script files for starting and stopping the WaterkenTM server. The folder also contains six subfolders. These subfolders contain the following types of files:

  • config/: configuration files for the WaterkenTM server
  • jar/: JAR files for the WaterkenTM server
  • mdb/: the sample MS Access database for this tutorial
  • www/: static files, including schema files
  • xdb/: resource files
  • xslt/: XSLT files

/

The root folder of the installation contains the product license file. You must read and agree to this license before using the software.

The root folder also contains script files for starting the WaterkenTM server.

  • go.bat: Start the server in an MS-DOS environment
  • go.sh: Start the server in a Linux environment
  • waterken.sh: A Unix init script for starting the server at boot time.

config/

The WaterkenTM server is highly configurable; however, typically you will not need to modify any of the provided configuration files. New databases are added to the server by adding configuration files to the config/ folder. See Database setup.

jar/

You do not have to write any Java code to use the WaterkenTM server. The jar/ folder contains the implementation of, and extensions to, the WaterkenTM server. If you download upgrades to the software, install them in this folder.

mdb/

If you are using Microsoft Access databases, keep them in this folder. If you are using another database, create a different folder for it, on this level.

www/

This folder contains static files served by the WaterkenTM server.

The layout of this folder is designed to facilitate internationalization and virtual hosting. To this end, the topmost subfolder is named after the RFC 1766 language tag for the language the files use. The default language is en-US. Within the language folder is a folder for each virtual hostname.

Among the hosted domains are those which define resource schemas. For example, every installation contains a waterken.com/ subfolder. The schemas for this tutorial are in the coffeebreak/ folder below that. When you write your own application, you will create a folder on the same level as waterken.com/ with the name of your organization. Below that, create a folder for each product.

xdb/

This folder contains the files that define the web of resources.

Like the www/ folder, the xdb/ folder is designed to support virtual hosting. Below the xdb/ folder is a subfolder for each of the hosted domains. You should create a subfolder in this folder with your own domain name.

Below the domain folder is a folder for each of the hosted resource webs. For example, the folder for the resource web created in this tutorial is xdb/www.waterken.com/coffeebreak/.

xslt/

This folder contains XSLT stylesheets that are automatically applied to generate different output types.

xslt/ is set up to accommodate internationalization and different media-types of output files. XSLT stylesheets that generate HTML are stored under html/. You should add folders on the same level for other media-types that you produce as XSLT output. Beneath the media-type folder is a language folder, with the default being en-US/.

Once you drill down below the internationalization folder, the structure of this folder parallels that of the schema folder.

The next page explains setting up the browser-based file manager.

top

Copyright 2002 - 2003 Waterken Inc. All rights reserved.

Powered by Waterken Server! Valid XHTML 1.0! Valid CSS!