Modelo User’s Guide

Overview

Modelo is VANTIQ’s web-based Integrated Development Environment (IDE). Modelo has two modes of operation, Development and Operations, each of which can have multiple projects. A project allows the developer or operator to organize tasks, such as user management or app and client building, as well as debugging, deployment and monitoring, in a graphical environment. This User’s Guide describes the Modelo features available in both Development and Operations mode and should be used in conjunction with the Introductory Tutorial.

Modelo Navigation Bar

The Modelo Navigation bar appears at the top of the browser window:

        NavBar

In the center is the control used to switch between Development and Operations modes. Each mode has its own set of projects. To switch modes, simply click the control segment with the mode you’d like. If you have at least one project in each mode, Modelo will restore the last project in each mode when switching to that mode.

In the right corner are three menus: Help, User, and Settings.

Help

The Help menu has three menu items:

User

The User menu shows the username of the currently authenticated VANTIQ user. This menu also allows the user to log out, change the user’s password, and display detailed information about the version of Modelo.

Settings

The Settings menu has several options to control the workflow when using Modelo. These options are used by the expert user who wants to speed up accomplishing certain tasks in Development mode.

Modelo Toolbar

The Modelo Toolbar appears below the Navigation Bar:

        Toolbar

The Toolbar contents depend on the currently selected mode. However, three Toolbar controls are the same in either mode:

Modelo Panes

Most tasks in Modelo can be accomplished by interacting with panes in the canvas area (the area under the Toolbar). For example, after completing the Introductory Tutorial your Modelo project might look like this:

        Panes

This canvas area contains four panes: Project Resource Graph, Data Generators, App: EngineMonitor, and Client: EngineSimulation. Each of these panes can be resized and their location on the canvas can be changed.

Each pane has a toolbar at the upper, right which contains a set of icons. Each icon is a button that performs a specific action for the pane. Some of these icons will appear on every pane, like minimize, maximize, and close, while others are unique to the resource type displayed within the pane. Here are the common icons and their behaviors:

        PaneButtons

From right to left, the buttons are:

        FullEditor

As mentioned, panes may have additional buttons based on their content. Hover the mouse over any button to display a tooltip which contains a title for the button.

Development Mode

A Development project contains a set of resources and related tools which provide an integrated environment for developing Applications, Collaborations and Clients. Typical Development Mode tasks are:

In Development Mode, the Modelo Toolbar contains six controls other than the three common controls: Settings, Debug, Deploy, Show, Add and Search. Several of these menu controls have a sub-menu section titled Advanced. Menu items contained in the Advanced section are not commonly used and can safely be ignored by beginning users.

Settings

The Settings menu has two menu items:

        FilterPRG

Debug

The Debug menu has nine menu items:

Deploy

The Deploy menu has four menu items:

Show

The Show menu has nine menu items:

Add

The Add menu is used to add VANTIQ resources to the current project. Each menu item references a resource. For example, selecting the App item displays the following dialog:

        AddApp

Use this dialog to either add an existing resource (selecting it from the list) or creating a new resource (using the New button). Once the resource is either added or created, it is added to the Project Resource Graph pane (if displayed) and the Project Contents pane (if displayed).

The Search field allows the user to search all resources in a namespace for text matching the contents of those resources. For example, if you want to search all resources having to do with the word weather, type weather then return into the Search field. This produces a dialog that might look like this:

        Search

This search found the word weather in four Rules, one Procedure, one Source and one Type. To add any of these resources to the current project, click the resource entry in the list.

Operations Mode

An Operations project provides a set of tools for administering and monitoring a VANTIQ namespace. Typical Operations Mode tasks are:

In Operations Mode, the Modelo Toolbar contains four controls other than the three common controls: Settings, Deploy, Administer, and Monitor. Several of these menus have a sub-menu section titled Advanced. Menu items contained in the Advanced section are not commonly used and can safely be ignored by beginning users.

Settings

The Settings menu has one menu item:

Deploy

The Deploy menu has four menu items, which are discussed in the Development Mode Deploy Menu.

Administer

The Administer menu has six menu items:

Monitor

The Monitor menu has nine menu items:

        RunningClient