Getting started

 

 

Developer environment

Prerequisite: Java (version 6 or higher) must be installed on your machine. To download Java, click here.

Quick start

Download latest version of QAFE.  This is a zipfile containing the render-engines for QAFE GWT (HTML/Javascript) and QAFE Flex (Adobe Flex). You will need a valid license for successfully deploying QAFE. Please register with us to receive the same in email. The email sent after registration will also have license for QAML Builder plugin about which it is explained later on this page.

Unzip the downloaded file and copy the platform-gwt\qafe-web-gwt-2.0.war to a location on your harddisk.

Since a war file is nothing else than a zip file, you can extract it (for example, just rename the file to qafe-web-gwt-2.0.zip). Remember the directory where it is extracted.

Our QAML Builder Eclipse plugin can be used to easily develop applications using QAFE. When you register you will get a trail license for this plugin too in your email. Choose one of the following options to have QAML Builder plugin in Eclipse :

Option 1: Download Prebuilt Eclipse QAFE distribution

If  you are new to Eclipse or don’t have Eclipse installed on your machine, please use the following links to download a complete prebuilt Eclipse containing all necessary plugins to develop and run your QAFE Applications.

Option 2: Installing the plug-in

If you are already familiar with installing Eclipse plug-ins (and have your own Eclipse already installed on your machine), you can use the update site URLs below for your version of Eclipse IDE for JEE Developers .

Eclipse 3.7 (Indigo)

Before installing the QAML Builder plug-in, you’ll need to install the maven-2-eclipse plug-in, which can be obtained from the update site below.

http://m2eclipse.sonatype.org/sites/m2e/

More information about the maven-2-eclipse plug-in can be found on,

http://eclipse.org/m2e/

The QAML Builder plug-in can be obtained from next update site,

http://www.qafe.com/developer/downloads/update-site/3.5/site.xml

For more details about installing the plug-ins, see Eclipse for Java EE Developers Installation Instructions.

Create a simple QAML Project

Once you have an Eclipse installation on your machine with the plugins mentioned above, you are ready to create a simple QAML Project. In order to start working on QAML projects and using the QAML Builder plug-in you have to download an instance of the QAFE Platform and obtain a license key. If you haven’t done so, please check under Quick Start at top of this page to know how.

As a pre-requisite, QAFE Platform should be extracted to a location which can be pointed to from within a QAFE project. This location will be used to serve as Path to QAFE in following steps.

Start creation of QAML Project by following the steps:

  1. Start Eclipse and select File > New > Project > QAFE > QAFE Project.
  2. When you use the QAML Builder for the first time, you’ll be asked to provide a valid license key. In the Install QAML Builder License Dialog License file field, browse and pick up the qafe-graphical-qaml-builder.lic file. (If you don’t have a license key you can obtain a free trial license key by email after registration.)
  3. Click Install. The New QAFE Project wizard is opened.
  4. Enter the name of your QAFE project and the name of your application.
  5. The path to QAFE should point to the extracted version of QAFE Platform as mentioned above.
  6. The license file should point to the locally stored license key file obtained by email after registration.
  7. Click Finish to create the new QAFE Project.
  8. Right click on SimpleQamlProject > Choose Maven > Choose Update Project Configuration to get the same to have Java project structure.
  9. Expand directory structure src > main > qaml.
  10. This is the location where you can start working on your QAFE application.
  11. Now you are ready to create your QAML code.
  12. Double click helloworld.qaml to open your first .qaml file in de QAML Builder and start editing.
  13. To add more .qaml files select File > New > Other.
  14. Select directory QAFE, QAML File and then click Next.
  15. Choose a proper location to store the .qaml file and its filename. The default location for storing the .qaml file is set to your Application directory.
  16. Click on Finish which will create and open your new .qaml file.

Running the simple QAML Project

  1. Before running your QAML application, you’ll need to build your application. This will create a directory with an assembly of your QAML application in QAFE Platform as well as a war which can be deployed on your server. To build your newly created QAML Project, Right Click on SimpleQamlProject > Choose Build QAML as shown below.
    (After successful build, if you don’t see the target directory, do a refresh on the project)
  2. The QAML Builder plug-in also offers an option to run and test your application inside eclipse on a Jetty server.
    To run the project Right click on SimpleQamlProject > Choose Run As > Choose QAFE Application as shown below
  3. Now an instance of Jetty server is started with your QAML application assembly deployed on it. Default browser of your machine will be invoked with QAFE Application. You can also use http://localhost:7070/SimpleQAFEProject/QAFEGWTWeb.jsp and open QAFE Application in other browsers.
  4. In the QAFE Application on browser under Programs menu you can see the SimpleQafeApplication through which is it possible to invoke the Hello World Qafe Application defined in helloworld.qaml

QAML Builder plug-in for Eclipse 3.5 (Galileo)/Eclipse 3.7 (Indigo) Installation Instructions

This procedure installs the QAML Builder plug-in for Eclipse. Before installing the QAML Builder plug-in, you’ll need to install the maven-2-eclipse plug-in. The screen shots might be different as per the version of Eclipse that being used.

  1. Start Eclipse, then select Help > Install New Software…
    Click on the Add… button.
  1. In the dialog that appears, enter the update site URL into the Work with text box:

    http://m2eclipse.sonatype.org/sites/m2e/

    Leave the Name text box empty or choose an appropriate name. Click OK.

  1. Back in the Install dialog, you should see the center box filled with the Maven Integration for Eclipse plug-in. Select the checkbox next to Integration for Eclipse. This will install the Integration for Eclipse plug-in. Click Next.
  1. Review the features that you are about to install. Click Next.
  2. Read the license agreement and then select I accept the terms of the license agreements. Click Finish.
  3. You will then be asked if you would like to restart Eclipse. Click Yes.
  4. After restarting you are ready to install the QAML Builder.
  1. When Eclipse is started, select Help > Install New Software…
    Click on the Add… button.
  1. In the dialog that appears, enter the update site URL into the Work with text box:http://www.qafe.com/developer/downloads/update-site/3.5/site.xmlLeave the Name text box empty or choose an appropriate name. Click OK.
  1. Back in the Install dialog, you should see the center box filled with the QAML Builder Plug-in. Select the checkbox next to the UI Designer Tools. This will install the QAML Builder plug-in. Click Next.
  1. Review the features that you are about to install. Click Next.
  1. Read the license agreement and then select I accept the terms of the license agreements. Click Finish.
  1. You will then get an authenticity or a validity warning. Click OK to continue the installation.
  2. You will then be asked if you would like to restart Eclipse. Click Yes.
  3. After restarting you are ready to use the QAML Builder.