Getting started

Installing the plug-in

If you are already familiar with installing Eclipse plug-ins, you can just use the update site URLs below for your version of Eclipse.

Eclipse 3.5 (Galileo)

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 3.5 Installation Instructions.

Create a simple QAML Project

Before 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 go to the license registration website,

http://registration.qafe.com/

The downloaded version of QAFE Platform should be extracted to a location which can be pointed to from within a QAFE project. Do the same for the license key which you’ve received by e-mail.

To use the QAML Builder plug-in, you first have to create a new project as a container for your QAML files. For this we’ll be using a QAFE Project.

  1. Start Eclipse and select File > New > Project.
  2. Select directory QAFE, QAFE Project and then click Next.


  3. When you use the QAML Builder for the first time, you’ll be asked to provide a valid license key.


  4. In the Install QAML Builder License Dialog License file field, point to the qafe-graphical-qaml-builder.lic file. If you don’t have a license key you can obtain a free trial license key by clicking on the “Get a free trial license for the QAML Builder” link, which redirects you to a license registration website. Click Install.
  1. After installation the New QAFE Project wizard is opened.


  2. Enter the name of your QAFE project and the name of your application.
  3. The path to QAFE should point to the extracted version of QAFE Platform as mentioned above.
  4. The license file should point to the locally stored license key file.
  5. Click Finish to create the new QAFE Project.


  1. When you expand your new QAFE Project in the Project Explorer you’ll see a project structure like,



  1. Expand directory structure src > main > qaml.
  2. In the qaml directory, a directory named after the Application name is created,



    This is the location where you can start working on your QAFE application.
  3. Now you are ready to create your QAML code.
  4. Double click helloworld.qaml to open your first .qaml file in de QAML Builder and start editing.
  5. To add more .qaml files select File > New > Other.
  6. Select directory QAFE, QAML File and then click Next.
  7. 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.
  8. Click on Finish which will create and open your new .qaml file.

Running the simple QAML Project

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. The QAML Builder plug-in also offers an option to run and test your application inside eclipse on a Jetty server.

  1. Right click on “SimpleQamlProject build.launch” in your SimpleQamlProject project root directory and select Run as > “SimpleQamlProject build” to build your QAML application. When you’ve used a different name for your project the .launch file will be named as “<Your project name> build.launch”.


  2. Now you’re ready to run your application.
  3. Right click on “SimpleQamlProject run.launch” in your SimpleQamlProject project root directory and select Run as > “SimpleQamlProject run” to run your QAML application. When you’ve used a different name for your project the .launch file will be named as “<Your project name> run.launch”.


  4. Now an instance of Jetty server is started with your QAML application assembly deployed on it.
  5. Go to your browser and point to http://localhost:7070/SimpleQAFEProject/QAFEGWTWeb.jsp to start your application.

QAML Builder plug-in for Eclipse 3.5 (Galileo) 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.

  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.xml

    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 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.