Getting Started with JEAF Modeling Assistant

Plugin for MagicDraw UML

Getting Started

How to install JEAF Modeling Assistant, configure it for your work and keep it up to date.


Requirements

Aspect Requirement
MagicDraw 2022x, 2024x or 2026x (also as MagicDraw Reader, see MagicDraw Reader)
Operating system macOS or Windows
Teamwork Cloud functions Access to a Teamwork Cloud server
JEAF Generator functions Maven, a JDK and the MagicDraw plugin “Eclipse UML2 (v2.x) XMI Export/Import” (part of MagicDraw)
License A license of anaptecs for the functions you want to use (see License)


Installation

JEAF Modeling Assistant is installed with MagicDraw’s Resource/Plugin Manager:

  1. In MagicDraw, open Help → Resource/Plugin Manager.
  2. Add the resource location (button “Add URL…”):
    https://www.jeaf-generator.io/distribution/jeaf-modeling-assistant/
  3. Select JEAF Modeling Assistant (group “Plugins (commercial)”, provider anaptecs GmbH) and install it.
  4. Restart MagicDraw.

Resource/Plugin Manager with the resource location of JEAF Modeling Assistant

The resource location always offers the latest version. Alternatively, a distribution file jeaf-modeling-assistant-<version>.rdzip can be imported with the button “Import” of the Resource/Plugin Manager.

License

The functions are licensed per group: Teamwork Cloud and JEAF Generator. Licenses are issued by anaptecs as license file (*.lic) for an organization or a person. To add a license after the installation:

  1. Open JEAF → Settings, page License.
  2. Click Add License File … and select the license file.

The page shows which groups are licensed and all license keys with their status and expiry date. Licenses can be ordered at jeaf@anaptecs.de.


Initial configuration

After the installation, configure JEAF Modeling Assistant for your work. All settings are made in one dialog: JEAF → Settings. The button Settings in the windows JEAF Generator and Local Git Changes opens it as well, directly on the page JEAF Generator.

Like MagicDraw’s specification dialog, the settings dialog shows its pages as a tree on the left and the selected page on the right. OK saves all pages at once, Cancel discards all changes. The dialog doesn’t block MagicDraw: it can stay open while you work, for example while you look up a directory or a branch.

Page What you configure there
General Behavior at startup, update check, environment check, active period of the Branches view; status of your licenses
JEAF Generator XMI export directory, Java, Maven and Git
Maven Projects The Maven projects of the model that is open in MagicDraw
Project Sets Which Maven projects are built in which order, with which Maven goals
License Your license files
About Version and third-party notices

All settings are stored only on your machine, in the directory ~/.jeaf/jeaf-modeling-assistant of your user. They apply to all MagicDraw versions on the machine. Settings of a model apply to all branches of a Teamwork Cloud project.


For a first start, typically only the following is needed: your license files on the page License, and for JEAF Generator the XMI export directory, the Maven Projects and at least one Project Set. Java, Maven and Git are usually found automatically.

General

Setting Default Description
Show “Open Recent Projects” on startup on Shows the dialog Open Recent Projects when MagicDraw starts. It can also be switched off in the dialog itself.
Check for updates on startup on Checks in the background whether a newer version of JEAF Modeling Assistant is available and offers to install it, see Updates.
Check MagicDraw environment on Checks Java version, JDK architecture, maximum heap size and garbage collector of MagicDraw at startup and watches the memory usage while you work. The results are shown on this page in the section Environment.
Active period of the Branches view 30 days A branch counts as active if it was created or changed within this period (1 to 3650 days). Used by the filter Only active of the Branches view.

The section License shows for each feature group (Teamwork Cloud, JEAF Generator) whether it’s licensed, and the details of the license: licensee, type, e-mail and expiry date. Manage Licenses … opens the page License.


JEAF Generator

Settings, page JEAF Generator

Settings of the model

These settings belong to the model that is open in MagicDraw. They’re only available if a model is open.

Setting Description
XMI export directory Directory into which Run JEAF Generator exports the model as Eclipse UML2 XMI. Your Maven projects have to read the XMI files from this directory. You can use MagicDraw path variables like <VARIABLE_NAME> (Options → Environment → Path Variables); the resolved path is shown below the field.

If the field is empty, the directory of MagicDraw’s project option Eclipse UML2 XMI Output Location is used (Options → Project, General). That option is stored in the model and therefore shared by everybody working with it, while the setting here applies only to your machine. The directory that is used is shown below the field. If neither is set, Run JEAF Generator opens the settings.

Java and Maven

These settings apply to all models.

Setting Default if empty Description
Java home JAVA_HOME of your environment JDK used by Maven.
Maven executable or home mvn found in PATH, MAVEN_HOME or the usual installation directories The Maven executable or the Maven installation directory.
Maven user settings (optional) Maven’s default ~/.m2/settings.xml Maven user settings file (settings.xml) passed to Maven with -s, for example with the repositories and credentials of your project.
Git executable (optional) git found in PATH or the usual installation directories Used by the window Local Git Changes. Without Git everything else works as usual.

Below each field, the value that is actually used is shown if it differs from your entry, for example if Maven is found automatically.

Check

The button Check verifies the entered settings without running JEAF Generator: Java and Maven can be executed, the Maven user settings file can be read (if set), the XMI export directory can be written, and all Maven projects of the model exist. Each result is shown with ✓ or ✗ and details, for example the error message of Maven. The same check also runs automatically before each run of JEAF Generator.


Maven Projects

Settings, page Maven Projects

The page lists the Maven projects that belong to the model that is open in MagicDraw, with name and directory. The name is taken from the pom.xml of the project. Projects whose directory doesn’t exist anymore are shown in red.

  • Add … adds a single directory that contains a pom.xml.
  • Scan Directory … finds all Maven projects below a directory, for example the directory into which you check out your projects. Modules of a multi-module project aren’t listed separately, only the top-level project. Select the projects you want and click Add. The directory is remembered for Rescan.
  • Rescan scans the remembered directories again, for example after new projects were checked out. New projects are offered for adding, projects that don’t exist anymore are removed (also from the Project Sets, after a confirmation).
  • Remove removes the selected projects, also from the Project Sets that use them.

When projects are selected (after a scan or for a Project Set), the columns Name and Directory can be filtered like the other tables of JEAF Modeling Assistant, the directories also as tree. The check box in the filter row above the check boxes checks or unchecks all projects shown with the current filter.


Project Sets

Settings, page Project Sets

A Project Set groups the Maven projects that have to be built to bring a model change to the code, for example first the API project and then the implementation that uses it. You select the Project Set in the drop-down list Current Project Set of the windows JEAF Generator and Local Git Changes.

  • New …, Copy …, Rename …, Remove, Move Up and Move Down manage the list of Project Sets. The order is the one shown in the windows.
  • For the selected Project Set:
    • Active (next to the name): only active Project Sets are offered in the drop-down lists Current Project Set. Deactivate Project Sets you rarely use to keep the lists short; they stay in the settings, shown greyed out with “(inactive)”. On by default.
    • Maven goals: the goals and options passed to Maven, default clean install, for example install -DskipTests -P generate.
    • Show local Git changes after the run: after a run, the window Local Git Changes shows the files the run changed. On by default if Git is available.
    • Maven projects: the projects built by a run, in this order. Add … adds projects from the page Maven Projects, Move Up and Move Down change the build order. A failed build stops the run, as later builds usually depend on earlier ones.


License

The page lists all license keys found on your machine with their status (active, expired or invalid), type, licensee, feature groups and expiry date.

  • Add License File … adds a license file (*.lic) you received from anaptecs.
  • Remove removes a license file you added.
  • License Agreement … shows the license agreement.

Licenses can be ordered at jeaf@anaptecs.de. Changes on this page apply immediately, without OK. How licensing works in general is described in License.


About

Shows name, version and copyright of JEAF Modeling Assistant and the notices of third-party content it contains.


Updates

On every start, JEAF Modeling Assistant checks in the background whether a newer version is available. If so, MagicDraw shows a notification, for example “JEAF Modeling Assistant 1.0.10 is available (installed: 1.0.9).”, with these options:

  • Install … downloads the new version and installs it into MagicDraw. Afterwards a second notification offers to exit MagicDraw; the new version is active after the next start.
  • Release Notes opens the Release Notes in the browser. The notification stays open, so you can install the update afterwards.
  • Skip this version doesn’t notify about this version anymore. Later versions are notified again.
  • Later shows the notification again at the next start.

The check can be switched off in JEAF → Settings, page General. Updates can always be installed manually in the Resource/Plugin Manager as well: the new version replaces the installed one at the next start, there’s no need to uninstall the old version.

What changed in each version is described in the Release Notes.