MDriven Designer gives developers, business analysts, and system architects a visual workspace for creating, inspecting, testing, and refining UML models.
Use this page to orient yourself in the MDriven Designer window and choose the right workspace tool for the task. For an introduction to what MDriven Designer produces, see Documentation:Introduction to MDriven Designer.
Workspace at a glance
The Designer window is organized around the diagram you are editing. You create and arrange model elements in the diagram area, navigate the model in the Model Tree, and change the selected element in the Property Inspector.
| Area | Location | Use it for |
|---|---|---|
| Main Menu Bar | Top of the window | Access primary commands, including the File, Edit, View, and Help menus. |
| Tool Bar | Below the main menu bar | Open commonly used editors and tools, change diagram-navigation or association modes, run checks, and start testing or execution tasks. |
| Diagram Area | Main central workspace, below the tool bar | Place and arrange classes and their relationships on the current diagram. A diagram is a view of model elements; it is not the model repository itself. |
| Model Tree | Right side of the window | Browse the model hierarchy and locate classes, diagrams, and other elements. |
| Property Inspector | Below the Model Tree | Inspect and edit properties of the currently selected model element, such as its name, type, or attributes. |
| Start Easy Wiki Access | Collapsible pane below the diagram area | Open the Start Wizard / Easy Wiki access from within Designer. |
Work in a diagram
A diagram is the visual arrangement you use to describe part of the model. The same class can be placed on more than one diagram. When you change the class itselfâfor example, by adding an attributeâthat change is reflected wherever that class is shown.
For example, you can place a House class on a diagram that describes properties and on another diagram that describes ownership. Adding an Address attribute changes the class in the model, so the attribute is available in both diagram views.
Create a class
- Select the New Class button on the tool bar.
- Click in the Diagram Area where you want to place the class.
- Select the new class.
- Use the Property Inspector to give the class a name and define its attributes.
For example, create a class named House, then add an Address attribute. The Property Inspector is where you refine the selected class rather than using the diagram only as a drawing surface.
Create an association
An association is a relationship between two classes. Use the Association Mode tool to create one:
- Select the appropriate Association Mode tool on the tool bar.
- Drag from one class to the related class in the Diagram Area.
- Inspect the resulting relationship and its properties in the Property Inspector.
For example, drag from House to Owner to model that the classes are related. Use the association tools when a type is not being used as an attribute type but instead represents a relationship between classes.
Control what a diagram shows
You can show a class on a diagram without showing every attribute. This lets each diagram focus on one concern while retaining the complete class definition in the model.
To choose which features are visible for a placed class:
- Right-click the class in the Diagram Area.
- Select Features.
- Select Pick show features.
- Choose the display mode: show only picked features, hide only picked features, hide all features, or the default display.
- Select the attributes or other features to show or hide on this diagram.
For example, show only Address and State on a property overview diagram. The other attributes remain in the repository and can still be displayed on another diagram.
Hide versus delete: important keyboard behavior
Be careful when pressing Delete in a diagram. In common diagram-editing use, Delete hides the selected attribute or class placement from that diagram; it does not necessarily remove the underlying model element. This is a quick way to reduce diagram clutter.
To remove an attribute or class from the repository, use Ctrl+Delete. You can use Edit â Undo to restore a removed item when needed.
For example, press Delete on an attribute when you want it hidden only from the current diagram. Press Ctrl+Delete only when you intend to remove that attribute from the model.
Use color to communicate meaning
You can assign a color to a class placement on a diagram without changing the class's default color. You can also set a default class color. An explicit color on one placement takes precedence for that placement.
For example, color a House placement on a workflow-focused diagram to draw attention to it, while retaining a different default color for the class elsewhere.
Model Tree
The Model Tree is the hierarchical navigation view of the project. Expand and collapse its nodes to find classes, diagrams, and other model elements, then select an item to inspect or edit it.
Use the Model Tree when the diagram does not show the element you need. For example, locate a class in the tree, select it, and then review its properties in the Property Inspector.
Property Inspector
The Property Inspector shows the details of the selected model element. Use it to edit the element rather than relying only on its label or position in a diagram.
For example, after creating a class in the Diagram Area, select it and use the Property Inspector to set its name. After selecting an association, use the same inspector to review and refine the relationship.
Tool bar tools
The tool bar provides direct access to common modeling, navigation, validation, and execution functions.
| Tool or command | What you can do |
|---|---|
| Start Wizard (Easy Wiki Access) | Open the in-Designer Start Wizard / Easy Wiki access in the lower-left pane. |
| Prototype and Test Tool | Open the system prototyper to test the model while you develop it. |
| Next and Previous Tool | Move between model diagrams. |
| Association Mode Tools | Drag between classes to create associations or locate a class and relationship when working with association classes. |
| Diagram Reference Window | Open a separate reference view of a diagram. |
| ViewModel Editor | Open the ViewModel Editor, where you organize how a client presents pages. |
| Turnkey Live-Editor | Open the ViewModel Editor with an MDriven Turnkey server as host so that you can work against a model running on that server. |
| Styles in Model Tool | Open model styles and define custom colors that can be inherited throughout the model. |
| Actions Editor | Open the Action Editor. |
| AccessGroups Editor | Open the AccessGroups Editor to define user groups and what those groups may see and edit in the application. |
| Model Check and Report Errors Tool | View model-design errors so you can correct inconsistencies. |
| Enterprise Architect Information Window | View information about the application's business information, processes, roles, tools, and infrastructure. |
| CloudForm â Cloud Connection Tool | Execute the model in a cloud application. |
| Overview Tool | Navigate between model diagrams. |
A practical editing loop
Use the workspace areas together as you evolve a model:
- Create or place a class in the Diagram Area.
- Select the class and define its name and attributes in the Property Inspector.
- Create relationships with an Association Mode tool.
- Use the Model Tree to find related elements that are not visible on the current diagram.
- Use Features â Pick show features to keep the current diagram focused on the attributes relevant to its purpose.
- Run Model Check and Report Errors and resolve reported design errors.
- Open the Prototype and Test Tool to test the model.
For a model with House and Owner, this loop lets you define both classes, connect them with an association, show property details on one diagram and ownership details on another, validate the model, and test it before continuing.
ViewModels and live editing
A ViewModel defines how the client views pages. Use the ViewModel Editor from the tool bar when you are organizing the client presentation based on your model.
Use the Turnkey Live-Editor when you need the ViewModel Editor to use a running MDriven Turnkey server as its host. This supports making changes while working with a model running on that server. MDrivenServer is the server component used when a running application loads and executes a model; see Documentation:MDriven Product Line for the product roles.