Tutorials

Getting you off to the best possible start

tutorials

This series of tutorials in ebook (pdf) and video formats will allow you to learn the basics to apprehend Modelio and the many features available in the tool and also to go further with more advanced use cases.

Ebooks

ebook

Create an Analyst model

Learn how to create an Analysis model to manipulate requirements, goals, business rules, and dictionaries.

(Tutorial applicable on Modelio 3.0.x)

ebook

Create a requirements diagram

This tutorial accompanies you step-by-step and explains how to create a requirements diagram.

(Tutorial applicable on Modelio 2.1.x and 2.2)

ebook

Transform an SVN teamwork project into a single user project

Learn how to transfer a multi-user model to an individual project.

(Tutorial applicable on Modelio 2.1.x and 2.2)

ebook

Generate SQL code from a UML model

This tutorial shows you how to generate SQL scripts from your UML models.

(Tutorial applicable on Modelio 2.1.x and 2.2)

ebook

Reverse Java source code into Modelio

This short tutorial guides you to reverse Java code into a model and produce UML class diagrams automatically.

(Tutorial made with Modelio 2.2)

ebook

Send a Modelio project to a distant user

Learn how to share a Modelio project with a distant user who has either no internet access, or who is not connected to a multi-user repository.

(Tutorial made with Modelio 2.2)

ebook

Setting up an SVN server for Modelio Teamwork Manager

This tutorial presents the strategic choices that must be made prior to setting up an SVN server for Modelio Teamwork Manager, along with the pratical actions necessary to ensure a successful setup.

ebook

Creating a Document Publisher Template

The Document Publisher module is used to produce quality documentation from the model. In order to generate adapted documentation for several contexts, this module provides a large set of predefined templates. This tutorial guides you through the steps of designing your own template. It then goes further with the Template Editor and describes a real example of generating documentation using a specific template.

ebook

Create a State Machine Diagram

This step-by-step tutorial shows you how to create a UML State Machine diagram. It is a detailed example showing as a result diagram a microwave oven StateMachine diagram.

(Tutorial made with Modelio 2.2)

ebook

Migrate a project from Modelio 2.2.x to Modelio 3.x

This tutorial illustrates the migration procedure of a Modelio 2.2.x sample project to Modelio 3.1.

Videos

Main features

This demo allows you to discover the functional and ergonomic richness of Modelio.

Modelio link editor

Models are complex graphs, and this new Modelio 2.1 feature enables you to navigate through different kinds of links (generalization, trace, import, ...) using a dedicated graph browser.

Rich text editing

Analysts need to combine their favorite text editors and office tools with their modeling tool. Modelio integrates MS-Word, MS-Office or LibreOffice, enabling you to attach any rich text (graphic or table) to model elements, in order to use it when you generate documentation.

Start with Document Publisher

Learn how to quickly generate documentation from your models.

Advanced features of Document Publisher

Learn how to assemble multiple documents and obtain a customized and attractive documentation in different formats (HTML, OpenXML, ...).

Apply a design pattern

This tutorial shows how to apply a design pattern to an existing model. For this, we use a feature embedded in the Modelio tool (Softeam distribution). This feature is embedded in Modelio in its version 3.4.0.

Overview of Java Designer

Find out how you can boost your Java productivity and quality with Modelio and UML using Modelio Java Designer.

Java reverse and improved Javadocs

Find out how Modelio can reverse Java code to build a UML architectural view, and how Modelio can improve existing Javadocs by inserting browsable UML architecture diagrams.

Java utility methods

Learn how Modelio can automatically generate Java utility methods and keep them up-to-date when the model is modified.

JUnit tutorial

Learn how to generate a JUnit test model from a Java model.

Requirements embedded in models

This demo shows the many requirement views (diagrams, spreadsheets, forms, link editors, matrixes, Excel coupling), the generation of document, traceability analysis, connections to other model elements, and the broad usage between several repositories (constellation).

Modelio Server demo

Demo model governance within enterprises (contains sound).

Deploy a module to the catalog

The Modelio modules catalog is a list of all modules which are known to your local Modelio installation. By default, the modules that appear in the modules catalog are those provided with your product installation. You can add other Softeam modules.

Note: Adding a module to the modules catalog does not automatically select it for use in your current Modelio project. All modules that you want to use in a project must be selected via the "Configuration/Modules…" context menu command.

  1. Run the Configuration/Modules catalog… command. The Modules catalog opens.
    modules catalog open
  2. Click on Check for new versions...The Modules version checker window opens. It shows the available modules. Just select the modules you want and click on Add to catalog
    modules catalog version checker

The module is now available to be used in your projects.
Please note that commercial modules need a valid license in order to be used in your projects.

Modeling the system structure

Modeling the global system structure of the industrial automation unit

Let us first look at the modeling of the global system structure as illustrated in the image on the right. This figure illustrates the composition of the system and the internal interactions, mainly by using a SysML block diagram. Here, the unit has been composed of three subsystems:

  • the physical subsystem
  • the control subsystem
  • the supervisory subsystem

As shown in the image, the control subsystem controls the physical subsystem by means of certain smart devices.

Modeling the structure of the system

Modelio generated document examples

Use Modelio Document Publisher to generate highly professional documentation

See documents generated from Modelio

Depending on the customizable document template used, Modelio is able to generate documents that meet your objectives and document standards.
(Click on the images below to access the corresponding documentation)

More information about the Modelio Document Publisher module

Softeam INCOSE Solution (OpenXML)

incose_openxml

Automatic document generation is one of the many features of the Modelio environment. Here, in this particular case related to the INCOSE 2012 Tool Vendor Challenge (TVC) Solution, an automatic OpenXML document was generated from the modeled project.
You can also consult a PDF version of this document.

Incose TVC Solution - Web Model

preview_webmodel_thumb

The Web Model enables designers and project managers to review the complete specifications of a system (for example, hierarchy, system composition, etc.) without having to install Modelio. This can also be beneficial for off-line usage. These specifications in turn can be commented upon by reviewers, enabling system designers to carry out any necessary modifications, and resulting in increased synergy.

SysML - Modeling a use case diagram

Modeling the use case diagram illustrating global system behavior

The figure on the right provides an abstract overview of system behavior through a SysML use case diagram. The use case illustrates the system behavior that is visible to the end user and external to the system. In the figure, there are several use cases present, related to how the system is operated, controlled, supervised etc. Here, plant refers to the experimental industrial automation unit.

Modeling the use case diagram related to system behavior