Rambutan

http://rambutan.sourceforge.net

Requirements Management Tool for Busy System Analysts

Introduction

Rambutan is a set of end-user applications software that assists a system analyst in the gathering and categorization of facts for a requirements specification document. In its current state, the product consists of two programs that perform similar functions. A handheld application is used to gather facts in the client's site while a desktop application is used to edit and further refine the requirement statements in the analyst's office. Both applications allow the user to enter, modify, and display data that make up a requirements specification document.

The concepts behind Rambutan lies on RQML 0.9, an XML-based requirements specification document format. In turn, Requirements Markup Language (RQML) is based on a set of best current practices in requirements engineering. This design decouples Rambutan from any specific methodology for requirements engineering.

Both the desktop application and its handheld counterpart are implemented using the Java programming language, allowing them to share some common code. However, it is not possible to code both applications to the same API. The desktop application is programmed for the Java 2 Standard Edition platform, version 1.3. On the other hand, the handheld application is programmed to run under the SuperWaba virtual machine using its own API. Both applications are GUI-based single-user systems.

Compared to other requirements management tools, Rambutan offers these competitive advantages:

System Requirements

Installation

Desktop Installation

Simply copy these files from the dist directory into their own installation directory; in the CD-ROM they may be found in /Rambutan/dist/desktop:

The file Rambutan-desktop.jar is an executable JAR file for the desktop, application. Therefore, it may be run by using the command:

java -jar Rambutan-desktop.jar

On Win32 systems when JRE 1.3 is properly installed, double-clicking the file will also run the desktop application.

PalmOS Installation

Use the Palm Install Tool to install the program files.

  1. Install SuperWaba Please install the following files in your device:
  2. Install Rambutan Please install these files from the /Rambutan/dist/handheld directory in the CD-ROM using the Palm Install Tool:

See General Installation of Programs which use SuperWaba under PalmOS for complete instructions on installing SuperWaba programs to PalmOS handhelds.

PocketPC / Windows CE Installation

Run the CEinstall_RunMe.bat file located in the CD-ROM in folder /SuperWabaVM/ce OR follow the instructions below:

  1. Install SuperWaba
    1. Please install these files in your WINDOWS CE / POCKET PC device under the /SuperWaba directory (from the root) in your handheld device.
      • SuperWaba.exe (VM)
      • SuperWaba.pdb (API Classes)
      • XPlatIoUiUtil.pdb (Optional API Classes)
      • MSW.pdb (Font file)
    2. You must choose the right EXE file located under the directories, according the processor and which platform you're using (those EXEs are located under the directory /SuperWabaVM/ce in the CD-ROM.
    3. File SuperWaba.pdb is located in folder /SuperWabaVM/xplat. File MSW.pdb is located in folder /SuperWabaVM. Both files are located in the CD-ROM.
    4. When installing a SuperWaba program, be sure to install both EXE and PDB files generated with Exegen and Warp. The EXE file must be installed in the Start Menu, idealy under a folder called /SuperWaba in your handheld device, along with other SuperWaba programs.
    5. Create a SuperWaba.lnk file with the following line, installing it in the Start Menu:
      24#\SuperWaba\SuperWaba.exe
  2. Install Rambutan
    1. In your handheld device, create a subdirectory called Rambutan under the /SuperWaba directory.
    2. Copy these files from the /Rambutan/dist/handheld directory in the CD-ROM into the Rambutan directory in the handheld device:
      • Rambutan.pdb
      • Rambutan.exe For Rambutan.exe, you need to choose the correct file for the platform you are using, just like you need to select the correct SuperWaba.exe file. These files are located in a subdirectory under the /Rambutan/dist/handheld directory in the CD-ROM.

See the General Installation of Programs which use SuperWaba under Windows PDA for complete instructions on installing SuperWaba programs to PocketPC / Windows CE handhelds.

This document describes the installation procedure of SuperWaba for end users. Developer should download another package from http://www.SuperWaba.org . The Runtime Environment may be found in the CD-ROM in the directory /SuperWabaVM or can be downloaded at http://www.SuperWaba.org/install .

General Requirements

SuperWaba runs on most PDAs with PalmOS and most Windows CE/PocketPC models with WinCE 2.11 and higher. SuperWaba as of version 3.5 is known NOT to run on the following devices:

PalmOS Installation

Download and install the following files:

After this installation-process you should see a new program called SuperWaba on your Palm. Launching this program will give you a welcome screen of SuperWaba and you know that the installation of SuperWaba succeeded. The other files coming with SuperWaba are additional libraries which might be used by applications. You should install those only when mentioned by an application you intent to install. Some SuperWaba examples included in the SDK require them, so don't forget to check the SuperWaba.pdf file (included in the SDK).

General Installation of Programs which use SuperWaba under PalmOS

Each program which uses SuperWaba consists of at least two files:

where PROGRAM is the name of the program to be installed. Several programs come with additional .pdb or .prc files, and might require the installation of some of SuperWaba's additional libraries, as stated in the program's documentation.

CE / Pocket PC Installation

Find out version the platform and processor your handheld is using. Possible platforms are HPC211, PPC211 and PocketPC; possible processors are MIPS, SH3 and ARM. Open Internet Explorer from within your handheld, choose this page and download the zip file with the correct platform_processor combination.

SuperWaba.PLATFORM_PROCESSOR.cab

After this installation-process you should see a new program called SuperWaba on your PDA. Launching this program will give you a welcome screen of SuperWaba and you now that the installation of SuperWaba succeeded. The other files coming with SuperWaba are additional libraries which might be used by applications. You should install those only when mentioned by an application you intent to install. Some SuperWaba examples included in the SDK require them, so don't forget to check the SuperWaba.pdf file (included in the SDK).

General Installation of Programs which use SuperWaba under Windows PDA

Most programs can be installed in the same way SuperWaba has been installed, using a cab file. Download the program, then search for a bat file called PROGRAM_install.bat. Launch it and the installation will start. And don't forget to read the program's documentation.

License

Usage of SuperWaba is governed by the
AMENDED GNU LESSER GENERAL PUBLIC LICENSE
GNU LGPL Version 2.1, February 1999
Amended, October, 2001

Read the file http://www.superwaba.com.br/etc/license.txt (also included in the SDK).