Chapter 4. Software Reference

Table of Contents

4.1. Download Packages Overview
4.1.1. Stable Releases
4.1.2. Development Version Access
4.2. Framework Components Manual
4.2.1. General Remarks
4.2.2. System-Wide Components
4.2.3. Language Specific Components
4.2.4. Location Specific Components
4.3. Framework Tools Manual
4.4. Demo Components Description
4.4.1. General Remarks
4.4.2. Available Answer Data

The following subsections document the software that comes with the QALL-ME Framework. We start off in section 4.1 with an overview of which pieces of software come with the framework and where to actually get them from. Section 4.2 is probably the most important subsection: it is a manual for the components that the QALL-ME Framework consists of, i.e., it contains detailed technical descriptions of component interfaces. After this manual, section 4.3 will give you an overview of utility scripts and other small tools that come with the framework. Finally, section 4.4 closes with a documentation of the demo components which are available for the framework.


All source files which come with any of the packages of the QALL-ME Framework are encoded in UTF-8 if not otherwise marked. The only exception are Java Properties files which are encoded in ISO-8859-1.


Depending on the locale of your OS environment the encoding of the source files may not correspond to your system’s default encoding, so be prepared to set up your working environment accordingly in order to avoid strange-looking-character issues or even worse problems.

There are basically two ways for getting software and other files for the QALL-ME Framework: the classic package downloads provide you with stable releases of the QALL-ME Framework and demo implementations for the framework components – see section 4.1.1: “Stable Releases” for more information. The second way of getting QALL-ME Framework files is direct access to the current development version of the framework and its demo components; read section 4.1.2: “Development Version Access” for details on this.

Stable package releases should be the right thing for most people who are interested in using the QALL-ME Framework. They are tested and contain only such things that are really relevant for testing and using the framework. Package releases are provided through the file release system on the QALL-ME Framework’s project page. Currently we provide releases/versions of two different packages:

  • The QALL-ME Framework SDK is the major package of the QALL-ME Framework. It is mandatory if you wish to develop your own QA system with the framework. In case you are just trying out the framework, then downloading only the DemoKit might suffice.

    The SDK contains the source code of the system-wide components of the framework as well as all WSDL interface definitions of the framework’s components. Furthermore the package contains dependency libraries for the framework’s system-wide component implementations. Finally, you can find this documentation for offline reading in the releases, too.

  • The DemoKit is an optional package which contains demo implementations of the QALL-ME Framework components. This encompasses pre-compiled WAR files for all system-wide framework components and demo implementations for QA subsystems for several languages and locations. The WAR files are ready for direct deployment and testing in your own Java EE 5 compliant application server.[9] However, the DemoKit is not only intended for users who are just trying out the QALL-ME Framework: it also contains the sources of the demo component implementations which may greatly help developers to get started using the framework for their own QA system. In addition the DemoKit contains several Ant scripts that show how WAR files can be easily created.


If you are just trying out the QALL-ME Framework and if you are unsure which package to download for this purpose, then simply fetch the DemoKit and directly head for our “Getting Started” Tutorial in section 3.2.

The development version of the QALL-ME Framework should usually only need to be considered by people who wish to contribute to the development of the framework itself. The development version may not always be stable or even fully functional. You can get the latest development version through SVN access.

The SVN subpage on the QALL-ME Framework’s project page provides all information you need related to accessing the framework’s SVN repository. Usually you will want to check out the current development version using something like svn co qallme. If you actually plan to contribute improvements or other additions to the project, then please contact the developers on the project mailing list. Section 5: “Possible Extensions provides you with ideas for such improvements.

[9] See the tutorial in 3.1.1: “Java EE 5 Application Server” for simple installation instructions for your own application server