The Astah Plug-in architecture makes it possible for you to empower Astah by adding your own functions.
You are able to add your own components like menu or extended views to Astah’s GUI.

In this tutorial, we will introduce you how to develop Plug-ins for Astah with a few samples.

section divider


Below is a table of software and its version that is used in this tutorial. You can use other versions of software, but please note that some settings or appearance of dialogs may look different than ones we have in this tutorial.



OSWindows 7, Ubuntu Linux 11.10
JavaOracle JDK 7
AstahAstah Professional, UML, Community 6.7 and Astah SysML 1.1
IntelliJ IDEA11.1
section divider

Astah Plug-in architecture

When you launch Astah it will load all of the plug-in files that are located in the directory below:
Userhome\.astah\professional(Astah’s edition)\plugins.
The Plug-in files need to be .jar format and also to be OSGi bundle because Astah’s Plug-ins architecture uses OSGi Runtime.

We’ve prepared SDK for you to develop Astah Plug-ins with which automatically packages OSGi bundle and also allows you to use Plug-ins on Astah without storing them in the directory above during your plug-in development. Now let’s set up the environment to develop plug-ins!

section divider

Set up the development environment

We provide Astah Plug-in SDK which is based on Maven3.
In order to set up the environment to develop plug-ins, you need to meet the system requirements of Astah’s – the edition you are using.

System Requirements:

First, extract the Astah Plug-in SDK to a folder and then set the following environment variables.

Add [ASDK_HOME] and specify the folder where you deployed the Astah Plug-in SDK:

e.g.) set ASDK_HOME=C:\dev\astah-plugin-SDK-1.0

Specify “%ASDK_HOME%\bin” (“$ ASDK_HOME /bin” if you are using Linux or Mac OS X) folder to [PATH], where the executable files of Astah Plug-in SDK’s exist:

e.g.) set PATH=%ASDK_HOME%\bin;%PATH%
Then run the command below.
> asdk

If the below appears, that means an installation of Astah Plug-in SDK is completed.

> astah* Plug-in SDK version: 1.0

Now, run the command below to make sure Astah launches on the SDK.:

> astah-launch

Then Astah should launch now.

section divider


If Astah doesn’t launch by the command, please check the settings.xml and set the correct location, Astah’s edition and OS you use in the %ASDK_HOME%\conf\settings.xml as below.

  <id>astah-professional-windows</id> <!-- Specify the correct edition of Astah and OS you use.  -->
                                      <!-- In this case,Astah Professional is used on Windows. -->
      <exists>C:/Program Files/astah-professional/astah-pro.jar</exists>  <!-- Make sure to specify the correct path -->
    <astahPath>C:/Program Files/astah-professional</astahPath>  <!-- Make sure to specify the correct path -->
       <name>Local Astah* Plugin Repository</name>
section divider


Astah Plug-in SDK is using Maven 3 internally.