# MD_plugin_skeleton

**Repository Path**: mirrors_IncQueryLabs/MD_plugin_skeleton

## Basic Information

- **Project Name**: MD_plugin_skeleton
- **Description**: MagicDraw plug-in development harness
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://build.incquerylabs.com/jenkins/buildStatus/icon?job=MagicDraw-OSS%2Fplugin-skeleton%2Fmaster)](https://build.incquerylabs.com/jenkins/job/MagicDraw-OSS/job/plugin-skeleton/job/master/)

## What is this skeleton?

This is an open source skeleton project for MagicDraw plugin development. It contains (i) the definition of a two actions that uses VIATRA queries and transformations, (ii) Gradle-based building infrastructure and (iii) Jenkins-based CI configuration.

### Actions
* Run menu "Examples" > "Correct all port types", it should run a transformation to add types to Ports that have no type specified, but are connected to a typed port.
* Run menu "Examples" > "Generate Python code", it should run a transformation to generate python code from the model. User has to select the top-level package from the transformation will start and the target folder to store the generated files. 

### Gradle
This skeleton project uses [gradle](https://gradle.org/)-based building infrastructure. Gradle jobs are defined in `com.incquerylabs.magicdraw.plugin.example/build.gradle` including the extraction of dependencies and building an installable plugin.

For more details check the related [wiki page](https://github.com/IncQueryLabs/MD_plugin_skeleton/wiki/Build-and-CI)

### Jenkins
This repository is connected to a [Jenkins](https://jenkins.io/) build job to provide automated build and deployment of the source code. The presented badge shows the status of the jenkins job running on the IncQuery Labs' infrastructure. The actual job is accessible from [here](https://build.incquerylabs.com/jenkins/job/MagicDraw-OSS/job/plugin-skeleton/).

For more details check the related [wiki page](https://github.com/IncQueryLabs/MD_plugin_skeleton/wiki/Build-and-CI)

[![Build Status](https://build.incquerylabs.com/jenkins/buildStatus/icon?job=MagicDraw-OSS%2Fplugin-skeleton%2Fmaster)](https://build.incquerylabs.com/jenkins/job/MagicDraw-OSS/job/plugin-skeleton/job/master/)

 
## How to use:

- Ensure you have Java 8 (newer Java is only supported in Gradle 5+, but our current build script requires Gradle 4.3).
- Install product: Eclipse IDE for Eclipse Committers, version: latest (tested with up to 2020-03)
- Install VIATRA SDK 2.3.0  http://download.eclipse.org/viatra/updates/release/latest
- Install UML 2.5.1 metamodel: 
    * Check section **Install UML Metamodel to Eclipse** describing the workflow of this process 
    * Users on the internal IncQueryLabs network can use http://albert.internal.incquerylabs.com:10080/magicdraw.metamodel/
- Clone this repo
- Import the projects in it
- Right click project com.incquerylabs.magicdraw.plugin.example > "Configure" > "Add Gradle Nature"
  - (If nature is automatically recognized and added, right click project > "Gradle" > "Refresh" instead)
  - This will synchronize it (loads tasks, and downloads dependencies from maven)
- run 'extractDependencies' task (downloads and sets up MagicDraw)
  - Show View: Gradle Tasks
  - In the view toolbar, click Refresh Tasks for All Projects
  - In the view menu, check Show All Tasks
  - Run com.incquerylabs.magicdraw.plugin.example > other > extractDependencies
- Right click project com.incquerylabs.magicdraw.plugin.example > Gradle > Refresh Gradle Project
  - This will synchronize it again (loads MD dependencies)
- run 'runJava' task (this will start MagicDraw)
- Create or open a project
- Run menu "Examples" > "Correct all port types", it should run a transformation to add types to Ports that have no type specified, but are connected to a typed port.

## Install UML Metamodel to Eclipse 

To define and compile queries in the VQL language, VIATRA requires the UML Metamodel to be installed. Here is a generic workflow to install UML Metamodel as a _p2 repository_.

### 1 Import MagicDraw's example project to Eclipse and change the target platform
 1. Start Eclipse
 1. File > Import > Existing project into workspace > Select archive file > `$Your MagicDraw installation$/openapi/ide/eclipse.zip` > check only `MagicDraw (MagicDraw/)` > click on "Finish".
 1. In the "Package Explorer", right click on `MAGIC_DRAW_INSTALL_DIRECTORY` under the newly imported project > Select "Properties" > Click on "Edit" > Set the value to `$Your MagicDraw installation$` > Click on "Ok".
 1. Open "MagicDraw bundles.target" > Click on "Set as Active Target Platform".

### 2 Create a feature package to host a p2 repository of UML Metamodel
 1. File > New > Feature Project
	* Project Name: `com.magicdraw.uml.metamodel`
	* Feature ID: `com.magicdraw.uml.metamodel`
	* Feature Name: `UML Metamodel`
	* Feature Version: 1.0.0.*
 1. Click on "Next" to select the referenced plugins
 1. Select "com.nomagic.magicdraw.uml2" and its dependencies (check this [wiki page](https://github.com/IncQueryLabs/MD_plugin_skeleton/wiki/Dependencies-of-UML2-Plugin) for the current list)
 1. Right click on the project and select "Export" > "Deployable Feature" > "Finish"
	* Destination: Directory - Select the destination where p2 repository will be hosted `$UML p2 repository$`
	* Options: "Package as individual JAR archives" and "Generate p2 repository"

### 3 Switch back to the original target platform
 1. Window > Preferences > Plug-in Development > Target Platform > Select "Running Platform"

### 4 Install UML metamodel to Eclipse
 1. Help > Install New Software... > Add... > Local... > Select `$UML p2 repository$`
 1. Uncheck "Group items by category" to see the installable feature
 1. Check "UML Metamodel" and click on "Next" then click on "Finish"


## Troubleshooting

- MagicDraw does not start, saying `Unable to create the actorSystem`
  - Try to start it again
- Installation of the UML Metamodel fails: `Cannot complete the install because one or more required items could not be found` 
  - There are missing dependencies of "com.nomagic.magicdraw.uml2" in the feature: check this [wiki page](https://github.com/IncQueryLabs/MD_plugin_skeleton/wiki/Dependencies-of-UML2-Plugin) for the current list.
- Installation of the UML Metamodel fails: `Could not find the exported unit with id: [feature name].feature.group version: 1.0.0.[current date]`
  - Restart Eclipse
- Gradle task shows error but nothing appears on the console.
  - Remove the Gradle nature and builder from project (you can do that by editing `.project` file). Then add the Gradle nature to the project (Right click on project -> Configure -> Add Gradle nature...)
- Eclipse cannot resolve (import) dependencies
  - Refresh the project by Gradle: right click on the project > Gradle > Refresh Gradle Project  
- Receiving the following error when MagicDraw tries to download a model from Teamwork Cloud: `Reply message has unexpected type: com.nomagic.esi.core.msg.LoginReply`
  - OpenAPI related jars appear twice on the classpath, hence you should temporarily exclude `lib/bundles/com.nomagic.esi*.jar` files from the gradle script.
- Gradle synchronization error when trying to build: `Could not determine java version from '13.X.Y'.`
  - Install Eclipse with jdk 8 selected for VM.