Modelio is a UML and BPMN Modeler whose features can be extended by additional modules.

A module is a set of so-called contributions that can be of different nature:

• additional metamodel material used to enrich the Modelio metamodel

• additional functions (commands)

• additional GUI (views, dialogs, diagrams)

Additional commands, views and diagrams are developed in Java code using the Modelio API which is a documented set of interfaces and classes providing basic and advanced services required for the development of a module. The Modelio API is organised into several services, each of which is specific to a particular aspect of Module development. In practical terms, these services are combined in order to implement most the functionalities of a module.

The Modelio API is currently delivered as a unique jar file (modelio.jar) that is to be used in module development projects.

The development of a Modelio module, like any software development project, has a development lifecycle made of several activities like development, debugging, building, testing and so on. The Modelio API is used in development and debugging phases when Java code is relevant.

This guide is mainly addressing developers facing the question “how to use the Modelio API practically?”

Although this guide shows many code snippets and describes some methods of the Modelio API classes, it should not be considered as an exhaustive reference of the Modelio API simply because many methods and services are not detailed here.
Should he require full and fine grained details about a particular service, the reader is advised to consult the Modelio API Java Documentation.

This guide tries to illustrate and explain the principles which are the base of the Modelio API and an important part of the learning process.