link:https://www.modelio.org[image:README/logo-modelio-v4.png[]]

== Modelio 5.4.1 Release

We are pleased to announce the release of Modelio 5.4.1

link:https://github.com/ModelioOpenSource/Modelio/releases/tag/v5.4.1[*Modelio 5.4.1 Download*]

https://github.com/ModelioOpenSource/Modelio/wiki[*Modelio 5.4.1 Documentation*]

=== Release Note https://github.com/ModelioOpenSource/Modelio/wiki/Release-541[*Modelio 5.4.1 Release Note*]

== Modelio Modeling Environment

Modelio is a modeling solution offering a wide range of functionality based on commonly used standards for enterprise architecture, software development and systems engineering.

Written for developers, analysts and software and systems architects, Modelio is first and foremost a modeling environment, supporting a wide range of models and diagrams and providing many services facilitating the modeling of your architectures, such as as model consistency-checking. Support for modeling and business processes (BPMN) is integrated into Modelio. These BPMN models can be linked to other standards supported by the tool, for example UML, so as to integrate these business processes into a larger context such as an enterprise architecture.

https://www.youtube.com/watch?v=GQKqQaL_m5g[image:README/modelio-video-link.png[Modelio Overview]]

== Main Features

• UML Modeler : Modelio is a first and foremost a modeling environment, supporting a wide range of models and diagrams, and providing model assistance and consistency-checking features.
• BPMN support integrated with UML : Modelio combines BPMN support and UML support in one tool, with dedicated diagrams to support business process modeling.
• Java code generator : The Java Designer module uses an RCP/Eclipse-style project file structure, and supports Java code generation and reverse, Javadoc generation and Java automation.
• XMI import/export : Modelio provides an XMI import/export feature that enables you to exchange UML2 models between different tools.
• HTML model publishing : With the HTML Publisher module, publish your models in HTML format.
• Extension system : Modelio can be extended for any language, methodology or modeling technique just by adding modules to your configuration. You can either use existing modules or else develop your own.
• Scripting language support (Jython) : Modelio provides integrated support of the Jython scripting language, for online requests, small scripts and macro definition.

== Supported Standards

• UML2 : UML2 is a general-purpose modeling language from the OMG, used in the field of object-oriented software engineering.
• BPMN2 : BPMN is a standard for business process modeling, providing a graphical notation for the specification of business processes.
• Archimate : Archimate is an open and independent enterprise architecture modeling language to support the description, analysis and visualization of architecture within and across business domains.
• XMI :XMI is an OMG standard used in the exchange of metadata information via the XML language.
• MDA : MDA is an OMG standard, which implements and uses model extensions in the development of software systems.
• TOGAF :TOGAF is an enterprise architecture framework, providing a complete approach to enterprise information architecture design, planning, implementation and governance.

== Project Samples

Here you will find a set of projects illustrating the main frameworks supported by Modelio.

=== Deployment of projects examples

To access example projects :

1. Download the desired project archive from the links below
2. In Modelio, use the "Import project from archive" function to load the project: File > Import Project ...

=== Projects

• https://github.com/ModelioOpenSource/Modelio/blob/master/Sample%20Projects/%5BArchiMate%20Example%5D%20Discount%20Travel%20for%20ArchiMate.zip[*Archimate : Discount Travel for ArchiMate*]
  The 'Discount Travel' project is an example of how to model the enterprise architecture of a travel agency to manage their reservation system.

• https://github.com/ModelioOpenSource/Modelio/blob/master/Sample%20Projects/%5BJAVA%20Example%5D%20Java%20Browser.zip[*JavaDesigner : Java Browser*] A simple HTML browser, based on a swing JEditorPane component.

• https://github.com/ModelioOpenSource/Modelio/blob/master/Sample%20Projects/%5BSysML%20Example%5D%20The%20plant.zip[*SysML : The plant*] In the Systems and Automation Department at Federal University of Santa Catarina (UFSC) there is an experimental unit of industrial automation that is used to demonstrate the operation of several control strategies using the same equipments and supervision tools.

• https://github.com/ModelioOpenSource/Modelio/blob/master/Sample%20Projects/%5BUML%20Example%5D%20Shopping%20Cart.zip[*UML : Shopping Cart*] This project contains the model for the Online Shopping Cart system, including all the models used to specify and realize the IT system. This model addresses the development of an online shopping cart system, that allows suppliers to sell their products directly online to customers. It is provided as a UML example covering the analysis of the business context and processes, and the design and deployment of a possible implementation.

== Build from Source

To understand how to compile the Modelio Modeling tool from source, please refer to the https://github.com/ModelioOpenSource/Modelio/wiki/Build-Modelio-Index[Building Modelio from Source Guide].

== Contribute

There are many ways to get involved in the Modelio community, on whatever level you choose. For each type of contribution, we recommend a certain level of knowledge as a user (someone who has some knowledge of the Modelio tool, as well as modeling or standards such as UML, SOA, BPM, ...) or a developer (someone with some knowledge of programming)

For more information, visit our community web page : https://www.modelio.org/community/get-involved.html[https://www.modelio.org/community/get-involved.html]

== Quick Start Guide

=== Creating a project

First you have to start Modelio by double-clicking on the Modelio shortcut. Once Modelio is started, go to 'File / Create a project...' or click on the [image:README/new-project-button.png[New Project]] button. This will open a Project Creation dialog box:

image:README/create-a-project.jpg[Project Creation]

Steps:

1. Enter a project name
2. Enter a description
3. You can choose whether to deploy the Java Designer module in your project by checking or not checking the Java project tickbox.
4. Click on "Create"

=== General User Interface

image:README/general-user-interface.jpg[Interface]

Key:

1. Model explorer (UML, BPMN, MDA, Requirements, ...)
2. Diagram view
3. Diagrams explorer
4. Module view
5. Properties view
6. Symbol view

image:README/gui-main-toolbar.jpg[Toolbar]

Key:

1. Save
2. Undo/Redo
3. Project Configurator: Project information, Work models, Libraries, Modules, Audit, URLs
4. Quick diagram creation
5. Diagram creation wizard
6. Advanced search tool
7. Perspectives: Change the layout of the views
8. Sort model elements

=== Creating elements

.From the diagram view image::README/create-element-diagram.jpg[Element Creation]

(Note: if you don't see the Modelio layout above, but wish to continue with this Quick Start, expand your project in the Model pane until you see a folder icon with the same name as your project, and select "Create diagram..." from the context menu, typically by right-clicking on that icon.)

Key:

1. Choose the type of element you want to create from the diagram palette
2. Click in the diagram to position the new element. Click again on the element to rename it (or click on the F2 keyboard button)

From the UML model explorer

To create your first element, right-click on the root package and then on 'Create element'. Choose the kind of UML/BPMN element you want to create:

image:README/create-element-uml-explorer.jpg[Element Creation]

Sibling creation

To create a series of elements, simply select the original element in the model explorer, then click on sibling button as many times as necessary. Each new element will be created empty and named with an incremental number. Sibling elements are created within the same container.

Clone creation

To clone an element, simply select it in the UML/BPMN explorer, then click on clone button as many times as necessary. Each new element will be created with the same sub-elements as the original one, and will be named the same.

=== Creating diagrams

Diagram creation ::

Click on the Diagram and matrix creation wizard icon in the main toolbar: + image:README/diagram-creation-wizard.jpg[Diagrams] + Steps: +

1. Select the kind of diagram you want to create +
2. Enter a name +
3. Select an owner for the diagram +
4. Click on "OK" to create the diagram +

Note: By default, the wizard shows the applicable diagrams for the selected model element. Click on the "Show only applicable diagrams and matrices" to show all existing diagrams.

Create elements in the diagram ::

To create elements in your diagram, you can either use the left hand side palette, or drag&drop existing elements from the UML explorer. + image:README/diagram-drag-drop.jpg[Diagrams]

Modify the graphic options ::

You can change the objects' graphic properties or the diagram's properties itself. The symbol view offers several options to change the graphic properties: color, font, line background, ... + image:README/diagram-symbol.jpg[Diagrams] + Key: +

1. Change the options in the Symbol view

Change objects' graphic properties ::

image:README/diagram-object-properties.jpg[Diagrams] + Key: +

1. Select a graphic element +
2. Change the options in the Symbol view +