QuickstartTutorial

Mario Ködding edited this page Oct 22, 2013 · 5 revisions

Table of Contents

Introduction

With this quickstart tutorial you should be able to get droMDAry up and running within 45 minutes (depending on how fast your internet conenction is).

For a more extensive introduction you should read our tutorial, which you can download here

Prerequisites and downloads

Because droMDAry relying on Enterprise Architect, which is only available in 32bit, the whole toolchain has to be 32bit (You can setup a 32bit toolchain on a 64bit system).

  1. Windows (XP/Vista/7)
  2. Enterprise Architect (Download the trial version here)
  3. Java SDK >= 1.6
  4. Eclipse Classic (Indigo 3.7.2 Download here)
  5. droMDAry cartridges (Download here)
Comment [magie]:
  • EA V6.5 and earlier is not supported.
  • Prefer checking out the latest version from our git-repository

Eclipse Installation

  1. Install Enterprise Architect and the Java SDK.
  2. Extract Eclipse to your preferred path. E.g. to C:\

Configure your eclipse

  1. Start up your eclipse by running eclipse.exe in your previous extracted eclipse folder
  2. on the Workspace Launcher dialogue, click on browse and create a new workspace folder e.g. c:\workspace
  3. Close Welcome window if you are using Eclipse the first time
  4. To configure your Network Connections (e.g. Proxy settings) go to Window --> Preferences --> General --> Network Connections

Install needed eclipse plugins

  1. Xpand SDK
    1. Go to the menu Help --> Install New Software
    2. Choose Indigo from the Work with drop down
    3. Type Xpand SDK into the Searchbar
    4. Click on Select All and Next
    5. Execute all required steps to install this plugin
  2. MWE SDK
    1. Repeat this from step c. for the plugin MWE SDK
    2. Restart eclipse
  3. Activate UML2 metamodel contributor
    1. Go to the menu Window --> Preferences --> Xtend/Xpand
    2. Activate UML2 profiles
    3. Move the UML2 profiles entry to the top most position, by clicking the up button
  4. Provide the Enterprise Architect API
    1. Either add the dirctory (C:\Program Files\Sparx Systems\EA\Java API\) which contains the SSJavaCOM.dll to the PATH environment variable
    2. Or copy the dll to a directory allready covered by the PATH (e.g. System32 or SysWOW64 on a 64bit system see WOW64 page on wikipedia)

Import the droMDAry cartridges

  1. Extract the droMDAry cartridges into your previously created eclipse workspace folder
  2. Import the projects into eclipse
    1. Go to File --> Import
    2. Click General
    3. Select Existing Projects into Workspace
    4. Click Next
    5. Check if Select root directory is activated
    6. Browse to c:\temp\dromdary
    7. Disable the Copy into workspace option
    8. Click Finish
    9. As result you should now see following new projects inside your workspace
      1. bva.exporter
      2. bva.generator
      3. common.exporter
      4. common.generator
      5. core
      6. docs
      7. environment
      8. jpa.exporter
      9. jpa.generator
  3. Fix build path for EA API
    1. Right click common.exporter
    2. Go to Build Path -> Configure Build Path
    3. Click Libraries
    4. Select eaapi.jar
    5. Click Edit
    6. Browse to C:\Program Files\Sparx Systems\EA\Java API
    7. Repeat this for bva.exporter and jpa.exporter
  4. Go to Project --> Clean to trigger a complete rebuild

Run the samples

As a quick way to see if all went right, you can just run the provided samples. The whole process is split up into several steps:

  1. Export the profiles which are modeled in EA to EMF
  2. Export the model from EA to EMF
  3. Generate code from the previously exported EMF models and profiles

Export Profiles

  1. Go to common.exporter/wf/
  2. Right click profileExportWorkflow.mwe
  3. Choose Run As ... --> MWE Workflow
  4. Follow the output of the console view, which ends with workflow completed in XXXXms
If you are using the demo version of EA a licensing window opens up in the background, which you have to confirm via Continue Trial.

Export Model

  1. Go to common.exporter/wf/
  2. Right click modelExportWorkflow.mwe
  3. Choose Run As ... --> MWE Workflow
  4. Follow the output of the console view, which ends with workflow completed in XXXXms

Generate Code

  1. Go to common.generator/src/main/resources/
  2. Right click workflow.oaw
  3. Choose Run As ... --> MWE Workflow
  4. Follow the output of the console view, which ends with workflow completed in XXXXms
  5. Now you see the generated files inside src/generated/java (overwrites every time the generator runs), src/main/java (implementations classes, which will not be overwritten)
  6. Attention: currently there are two knwon bugs. This is caused by a bug in the demonstration model, that will be fixed in the next release.
    1. com.tsystems cannot be resolved to a type
    2. The attribute message is undefined for the annotation type Isbn

Take a look at the model

If you want to play around with the model, you can take a look at common.exporter/Model/CommonTutorial.eap. Make sure to run an export each time before you generate the code.