Umple Using UmpleOnline V2
User Manual [Previous] [Next]
Using UmpleOnline V2
The following describes how to use UmpleOnline V2, accessible online at newumpleonline.umple.org. UmpleOnline V2 is a new version of UmpleOnline with almost all the same capabilities as classic UmpleOnline, but a different user experience. Both versions use the same Umple compiler and are maintained; the classic version remains available at try.umple.org. The repository for V2 is here.
For information about writing Umple models or code, look at the Getting Started section of this user manual, or any other topic in the left column of this page. Every example in this manual has a link to load it into classic UmpleOnline and a link to load it into UmpleOnline V2.
Basic use of UmpleOnline V2
- The first time you open V2, a welcome dialog offers a quick tour that walks you through building a state machine, viewing its diagram and generating code. You can skip it and explore on your own.
- To explore examples of Umple, open the example picker at the top centre of the page (it shows the name of the current example or model). You can also directly access these examples using a URL ending with the name of the example, as in classic UmpleOnline. For example click here to jump to the 2DShapes example: https://newumpleonline.umple.org/?example=2DShapes. The classic equivalent is described in Using UmpleOnline.
- To start a new model, choose 'Start Blank Model' in the example picker.
- To find any command quickly, open the command palette using the search (magnifying glass) button at the top right. You can type the name of an output, a view or an example to jump to it.
- To change preferences, click the sidebar button at the top left of the text editor, or press Ctrl+B. There you can choose a light, dark or system theme, and turn off 'Dynamically generate while editing' on slower machines or networks.
Saving, sharing and collaborating
- To share your model or work on it with others, click 'Share' at the top right of the text editor. The model is saved on the server, the URL in your browser changes to one ending in ?model= followed by an identifier, and that URL is copied to your clipboard. Anyone who opens this URL sees the same model and can edit it with you in real time; each collaborator appears in the Share menu. Use 'Copy link' to copy the URL again, and 'Stop collaborating' to stop. As with saved URLs in classic UmpleOnline, anyone who knows the URL can edit the model.
- To download your work, use the download button at the top of the diagram pane. You can download the Umple code as a .ump file, or the diagram as an SVG or PNG image.
- To work with several files, click the '+' next to the tab names above the text editor to add a new file. Each tab is a separate .ump file of the same model.
Left pane: Umple textual code
- Type any Umple code into this pane. Shortly after you stop typing, your model is compiled and the diagram or other output on the right is updated.
- Errors and warnings appear in the Output panel below the text editor. Each message has a link to the line that caused it and a 'More information' link to the page of this manual describing the problem. If the model has an error, the diagram is kept but marked as out of date.
- The editor highlights Umple keywords, and you can collapse blocks of code using the arrows next to the line numbers.
Right pane: diagrams and other outputs
- To choose what is shown in the right pane, use the output picker at the top centre (for example 'GraphViz Class Diagram'). It groups all outputs in one list: data model views (class diagram, entity-relationship diagram, CRUD user interface, Sql), state model views (state diagram, state tables), instance views, special views (feature diagram, structure diagram, Plain Requirements Doc, metrics and others), programming language code (Java, PHP, Python, C++, Ruby and others), formal methods and other modeling notations. In classic UmpleOnline, diagrams are chosen with the E, G and S buttons and generated code with the GENERATE menu.
- To edit a class diagram graphically, switch the 'Edit / GV' toggle at the top of a class diagram to
'Edit'. In this editable diagram:
- right-click the background and choose 'Add Class Here' to add a class;
- right-click a class to rename or delete it;
- drag a connection from one class to another and choose 'Association' or 'Generalization';
- right-click an association or generalization to delete it;
- remove an attribute or method with the button next to it.
- To change the layout of a GraphViz diagram, use the layout menu ('Dot (default)', SFDP, Circo, Neato, FDP or Twopi).
- To show or hide parts of a class diagram, use the eye button: you can filter classes, show or hide attributes, methods and traits, and use orthogonal edges. This corresponds to the Show and Hide options of classic UmpleOnline.
- To zoom, use the + and - buttons at the bottom left of the diagram, scroll, or click the button that fits the whole diagram in view. The button at the top right of the pane shows the diagram alone.
- To run your model, select 'Java Code' or 'Python Code' in the output picker for a model that has a main method, then click 'Execute' at the top of the page. Execution is only supported for Java and Python.
AI and tasks
- The 'AI' button at the top of the page opens the Umple AI configuration, where you choose a provider and enter your own API key and model. See UmpleOnline AI Capabilities for how the AI features work.
- The 'Tasks' menu lets you create and manage tasks, as described in Setting Up Tasks for classic UmpleOnline.
URL options
V2 accepts ?example= to load an example and ?model= to load a shared model. Some of the other URL options of classic UmpleOnline are not yet supported in V2.
See here for the statement regarding privacy and other risks when using UmpleOnline.