Installing Timber

Contents

        *   Prerequisites

*   Command Line Timber Installation

       Berkeley DB installation(Optional)

  Timber GUI Installation

*   Web Interface Installation

 

The following document describes how to install Timber. Timber has various entry points for use: a command line interface, a GUI interface, and an interface for accessing Timber over the web. Whichever entry point you wish to use, you will have to first complete all of the preceding installation steps. For example, if you wish to use Timber's XQuery capabilities through the GUI, you must first complete the TIMBER command line setup.

Prerequisites

  1. Windows 2000 or Windows XP
  2. Visual Studio 2002 or 2003. (Microsoft currently provides a free C++ compiler, but this tool contains a bug that does not allow it to build Timber. When this has been corrected by Microsoft, we will provide instructions for building Timber with these free tools).

Back to top

 

Command Line TIMBER Installation

 

Installation Procedure

 

  1. Download Timber.zip
  2. Unzip Timber.zip into <baseDir>
    1. <baseDir> is your desired location, e.g. C:\work
    2. The resulting directory structure will be:
      1. C:\work\Timber
      2. C:\work\Timber\DataMng, etc...
  3. Open Timber.sln in Visual Studio
  4. In the Solution Explorer window of Visual Studio, right click the Timber solution, and choose Build
  5. After several minutes (at least), you should see a message similar to: '20 succeeded, 0 failed, 2 skipped'

Configurations - Debug vs. Release

 

In Visual Studio, you may change the compilation type from Debug to Release. If you are coding and debugging in Timber you will probably want to build and work with the Debug configuration (or the Purify Debug configuration), but when you are ready to run tests or deploy the system, you will want to build the Release version (since it will be faster). To make any changes in compilation type, do the following:

 

  1. In the Solution Configuration drop down list, choose debug or release
  2. Repeat the above installation procedure of Timber.

Command Line TIMBER Usage

 

Detailed examples and information can be found in Query Interfaces. Below is a simple example to illustrate the loading of a document.

  1. C:\> cd <baseDir>\Timber\bin\Debug (if you built the Debug version in Visual Studio, otherwise you will go to the corresponding Release directory. In the remainder of this document will will use the Debug directory for our examples). Timber.exe should be present if all compilation steps were completed successfully.
  2. The following command will load the file sbook.xml into Timber.
    <baseDir>\Timber\bin\Debug>  timber -m load -r 1
    -d <baseDir>\Timber\bin\Data\sbook.xml
  3. Congratulations! You have just loaded an XML document into Timber.

Back to top

 

Berkeley DB Installation (Optional)

Timber uses Shore as the underlying data management system by default. Alternatively, you may use Berkeley DB as your data management system by following the procedure below.

1. Download Berkeley DB (Version 4.0.14 only, We cannot guarantee compatibility with any other versions)

    It comes with a solution file with many projects. We will use the "db_dll" project to build the required support library for Timber.

2. Unzip the downloaded file to <baseDir>/Timber/, change the top-most directory name to BerkeleyDB. So, the example of BerkeleyDB file path is <baseDir>/Timber/BerkeleyDB/btree

3. Open "Timber" solution name at the top in Visual Studio, right click on the solution "Timber" in Solution Explorer, Add Existing Project "db_dll(.dsp)" project from <baseDir>/Timber/BerkeleyDB/build_win32. Answer "Yes" if it ask you to convert to Visual C++ 7.0 or later.

4. Create two new configurations: Debug BerkeleyDB and Release BerkeleyDB by:
             i. Right click on "Timber" solution name at the top in Solution Explorer, choose Properties, click on Configuration Manager, click on db_dll project
             ii. Change Active Solution Configuration to "Debug BerkeleyDB"
             iii. Open the Configuration drop-down manual of db_dll project, and choose <New...>
             iv. In the New Project Configuration pop-up window, set the Project Configuration Name as "Debug Berkeyley DB", choose Debug from the Copy Settings from Drop-down list, uncheck Also create new solution configuration's, and click OK.
            v. Repeat step ii but select "Release BerkeleyDB". 
            vi. In the New Project Configuration pop-up window, set the Project Configuration Name as "Release Berkeyley DB", choose Release from the Copy Settings from Drop-down list, uncheck Also create new solution configuration's), and click OK.
            vii. Close Configuration Manger
            viii. Congratulations! You have just created two new configurations:
Debug BerkeleyDB and Release BerkeleyDB.

5. Select "Debug BerkeyDB" as Active Solution Configuration and make the changes below, then do the same for "Release BerkeleyDB":
     a. In the Solution Explorer of Visual Studio, Right click on db_dll, choose Properties, then General, and change the Configuration Type to Static Library (.lib), click OK
     b. In the Solution Explorer of Visual Studio, Right click on db_dll, choose Properties, then Librarian, then General and change Output File to be

            i. for Debug BerkeleyDB        ../libdebug/libdb40d.lib
            or
           ii. for Release BerkeleyDB  ../librelease/libdb40d.lib

    c. In the Solution Explorer of Visual Studio, Right click on db_dll, choose Properties, then C/C++, then Code Generation and change  Runtime Library to be Multithreaded Debug, click OK

6. You have just enabled the use of Berkeley DB with Timber. Once you built, you should find the final library file from BerkeleyDB will be in <baseDir>/Timber/BerkeleyDB/libdebug(or librelease)/libdb40d.lib

7. To use Timber with BerkeleyDB, choose the configuration you want (Debug BerkeleyDB or Release BerkeleyDB), then build db_dll, and ss_m project, respectively.

NOTE: To use BerkeleyDB-based Timber as a soap server, you need to start the soap server using command-line only, since the volume created by BerkeleyDB cannot be selected from the GUI.

Back to top

Timber XQuery Parsing Tools (and GUI) Installation

Installation Procedure

  1. Download XQueryParser.zip.
  2. Unzip XQueryParser into <baseDir>. This will result in the following directory structure:
    1. <baseDir>\XQueryParser
    2. <baseDir>\XQueryParser\MainGUI
  3. Open XQueryParser.sln in Visual Studio
  4. If you do not have IIS (Internet Inforamtion Service) running, you will see a “Web Access Failed” error box. Merely press Cancel and then OK. You will not be able to set up a web server using Timber, but you will be able to use all of the XQuery parser functionality through the GUI. If IIS is running, enter the appropriate path for your IIS directory. 
  5. In the Solution Explorer window of Visual Studio, do:
  6. Right click the XQueryParser solution, and choose Build
  7. copy <baseDir>\XQueryParser\Resources\xquery.cgt to <baseDir>\XQueryParser\MainGui\bin\Debug
  8. copy <baseDir>\XQueryParser\Resources\xquery.cgt to <baseDir>\XQueryParser\ParserRun\bin\Debug

Timber XQuery Parser Installation Configurations - Debug vs. Release


As with the command line build in Visual Studio, you may build the XQuery parsing tools in either Debug or Release mode. Use release mode if you are not actively coding and debugging the XQuery GUI code. To make any changes in compilation type, do the following:

 

  1. In the Solution Explorer window, do the following:
  2. Highlight the MainGUI project, change the setting to debug or release, and Build.
  3. Highlight the ParserRun project, change the setting to debug or release, and Build.

Timber XQuery Parser Usage


Below is a brief example of using the XQuery parsing command line tools.

 

  1. C:\> cd <baseDir>\XQueryParser\ParserRun\bin\Debug
  2. ParserRun should be present if all compilation steps were completed successfully.
  3. <baseDir>\XQueryParser\ParserRun\bin\Debug> parserrun -f -i <baseDir>\XQueryParser\Resources\Queries\xqsimple1.txt -o <baseDir>\XQueryParser\ParserRun\bin\debug\xqsimeple1_LOG.txt
  4. Congratulations! You have just created a physical plan from an XQuery statement.

 

Timber XQuery GUI Usage

Detailed information and examples can be found in Query Interfaces

Back to top

 

Web Interface Installation

Prerequisites


  1. java/javac 1.3+ or 1.4+
  2. Apache Tomcat (you can get it here)
  3. Apache Ant (for automated building; you can get it here)
  4. The Timber Soap Server up and running on a web accessible machine, or on your local machine. (This was compiled in the Timber Command Line Installation Section).

 

Installation Procedure
  1. Download Apache Axis, a SOAP toolkit, from the following website:  http://ws.apache.org/axis/releases.html. You will not need the source files for axis, so download xml-axis-*.zip

    Important note: We used Axis 1.0 in the creation of our web interface.  You may use newer versions, but we have not tested under these versions.
  2. Decompress this zip file, and install Axis. Denote the installation directory of Axis as <axis-1_0>. 
  3. Download TimberWebInterface.zip.
  4. Unzip TimberWebInterface.zip into <baseDir>
    1. This will create the directory structure
      1. <baseDir>\TimberWebInterface
      2. <baseDir>\TimberWebInterface\src 
    2. In <baseDir>\TimberWebInterface, locate the file build.xml, and modify the following parameters:
      1. catalina.home -> this is the location of your apache tomcat installation
      2. axis.home-> This is the location of y our Axis installation.

        This parameter is currently set to axis-1_0: <property name="axis.home" value="axis-1_0"/>. With this setting, the ant build script will look for axis in the axis-1_0 directory, directly beneath the directory containing the build.xml file. If the location of your Axis is different, simple change the value of "axis.home" to be <axis-1_0> at Step 2. 
         

      3. wsdl.url -> this is the location of the wsdl file describing the timber Soap service

    i. If you already have IIS (Internet Information Server) running on your machine, you just need to copy the file "<baseDir>\Timber\TimberSoap\timber.wsdl" to some place under Inetput/wwwroot directory (the default root for IIS directory) first, and modify build.xml accordingly. For example, if you copy the file into "C:\Inetpub\wwwroot\timber", change the following line in build.xml from 
                              <property name="wsdl.url" value="http://localhost/timber.wsdl" />                    
    to
                              <property name="wsdl.url" value="http://localhost/timber/timber.wsdl" />   

    You may type in the value (in our example, http://localhost/timber/timber.wsdl) into your web browser to double check its correctness. If the value is correctIf, you should be able to see  the file timber.wsdl from the web browser, . Otherwise, you will need to make sure IIS is running, find the correct path to locate timber.wsdl, and update build.xml accordingly.

     ii. If you do not have IIS running on your machine, you will first need to install it. For detailed instructions on how to install IIS on Windows 2000, please read here;  for Windows XP, please refer to here. After you install IIS, follow the above instruction in (i) to update build.xml. You will need to fix the ASP.Net by following the instructions below:

    (a) Stop IIS. For details on how stop and researt IIS, please read here if you are running windows 2000, or here if you are running windows XP (search by "restart IIS").

    (b) Open Command Prompt window, and reregister the aspnet_isapi.dll file by running C:\<WINDOWS>\Microsoft.NET\Framework\<version>\aspnet_regiis.exe-i. Please note that you will need to replace <WINDOWS> with the actual windows directory name, WINNT for Windows 2000 for example, and <version> with the actual  version number, v1.1.4322, for example.

    (c) Restart IIS.

                 d.    xquery.wsdl.url-> this is the location of the wsdl file descrbiing the timber XQuery Parser service      

    First of all, copy the "<basedir>/XQueryParser/Resources/xquery.cgt" file to <windowsdir>/system32 because IIS is the executable and assumes that as its local directory. Next, build xqsoap by following the instructions below

    i. Open XQueryParser.sln in Visual Studio

    ii. If you see an "Web Development Component not installed" error message, please close Visual Studio and install the required component first before continue. When the  message does not appear, you will be prompted to enter the appropriate path for your IIS directory, if you have not done so yet. Please follow the prompt, and enter the right path.

    iii. In the Solution Explorer in Visual Studio, right click on MainGUI and choose Build

    iv. The xqsaop folder should be copied to the IIS directory automatically. Please check the IIS directory, and make sure xqsoap folder has been copied into it. If yes, please skip v. and vi.and go to (2); otherwise, please manually copy xqsoap folder into the IIS directory, and then set its property by following the instructions below before continue to (2):

    (a) Right click on the xqsoap folder in the IIS directory, choose Property
    (b) In the xqsoap properties" window, choose the Web Sharing tab, and check Share this folder
    (c) In the Edit Alias prompt window, check  "Read" in the Access Promission, and choose the Application permission to be Execute (includes scripts)
    (d) Click OK and close Edit Alias prompt window. 
    (e) Click OK and close the xqsoap properties window.

    v. If you can locate the file xquery.asmx from your web browser through http://localhost/xqsoap/xqueryservice.asmx?WSDL. You do not need to update build.xml. Skip this part, and go to (2). Otherwise, go to  the Inetput/wwwroot directory, locate xqsoap, and update the following line in build.xml. For example, if the path to xqsoap directory is  "C:\Inetpub\wwwroot\timber\xqsoap", change the following line in build.xml from 
                        <property name="xquery.wsdl.url" value="http://localhost/xqsoap/xqueryservice.asmx?WSDL" />
    to 
                        <property name="xquery.wsdl.url" value="http://localhost/timber/xqsoap/xqueryservice.asmx?WSDL" />

    vi.You may type in the value (in our example, http://localhost/timber/xqsoap/xqueryservice.asmx?WSDL) into your web browser to double check its correctness. If the value is correct, you should be able to see the file from the web browser.

    1. Type in the following command from command prompt window: <baseDir>\TimberWebInterface> ant deploy  
    2. Start Tomcat
    3. Start Timber Soap Server: <baseDir>\Timber\bin\debug> TimberSoap
    4. The URL will be: http://localhost:8080/timberweb/index.html if you have set up the web interface on your local machine.  Simply replace the actual machine name for localhost if you want to access the web interface from a different machine.

     

    Back to top


    Last Update: 07/20
    /2004