Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Getting Started with Papyrus UMLLight"
(→Create the OSS Project: Added new project dialogs) |
(→Modeling the OSS Use Case: Reorderd the image captions) |
||
Line 251: | Line 251: | ||
In the New UML Light Model Project" resulting dialog, set the project name to "OSS" and Notice that the model name is given the same name. | In the New UML Light Model Project" resulting dialog, set the project name to "OSS" and Notice that the model name is given the same name. | ||
+ | |||
+ | 3. The dialog is shown. | ||
[[File:Create-UMLLight-Project.png|600px|]] | [[File:Create-UMLLight-Project.png|600px|]] | ||
− | + | 4. Set the project name to "OSS" and Notice that the model name is given the same name. | |
[[File:New UMLLightModelProjectDialog.png|600px|]] | [[File:New UMLLightModelProjectDialog.png|600px|]] | ||
− | |||
− | |||
=== Create the Use Case diagram === | === Create the Use Case diagram === |
Revision as of 12:22, 2 May 2019
Getting Started with Papyrus UMLLight
Contents
Introduction
As part of this tutorial, the trainee will:
- Learn how to download and install Papyrus UMLLight.
- Become familiar with the various aspects of the modeling environment such as workspaces, menus, views, perspectives and palettes.
- Become familiar with the elements that make up the“Papyrus UMLLight” subset.
- Through the implementation of a sample modeling project, become familiar with a simple model development approach that will enable you to use the elements that are part of the Papyrus UMLLight subset.
At the end of the training, the trainee will be able to apply their acquired knowledge in real project.
What this tutorial is and is not
what this tutorial IS | What this tutorial Is NOT |
---|---|
An overview of the Papyrus UMLLightuser interface | A UML specification tutorial |
An overview of the UML diagrams and elements available in Papyrus UMLLight | An exhaustive tutorial on all UML diagrams, entities, and semantics |
An hands-on experience developing a UML model with Papyrus UMLLight | A tutorial advocating a specific method for modeling software, |
What are Papyrus and Papyrus UMLLight
What is Papyrus
- * A complete open Source editor that Conform to UML, SysML, and other Object Management Group (OMG) standards
- * [An Eclipse Project [1]
- A familly of modeling tools
- Papyrus itself (both tool and platform) ("Papyrus")
- * Papyrus for information modeling ("Papyrus-IM")
- * Papyrus for Real-time ("Papyrus-RT")
- * and now Papyrus UMLLight
- * [Supported by the Papyrus Industry Consortium, a community of developers, committers and contributors from many organizations and involved in different application domains.
What is Papyrus UMLLight
- * A specialized variant of Papyrus that provides:
- * * an optimized “Foundation level” subset of UML;
- :: * with a streamlined user interface for creating, viewing, and editing models
Comparing Papyrus and Papyrus UMLLight
Papyrus UMLLight User personae.
After discusions with various stakeholders, the Papyrus UMLLight team defined the following three user personae to express the targeted users:
* Nicole, a [Papyrus novice, is knowledgeable in UML but not familiar with Papyrus or Papyrus UMLLight * Steve - a UML Novice and Student, a student and novice in UML, Papyrus, and Papyrus UMLLight * Brisha, a Basic UML User, only uses UML from time to time and then only for basic purposes such as documentation or, presentations
You can also have a look at the full personae descriptions
Installing Papyrus UMLLight
To install Papyrus UMLLight, follow these steps:
1. Ensure that you have Java 8 (or later) installed and configured for your operating system.
2. Go to: https://wiki.eclipse.org/Papyrus_UMLLight#Downloads
3. The list of downloads for different operating environments will be displayed:
- * Papyrus UML Light 0.0.1 RC2* for Windows 64bit
- * Papyrus UML Light 0.0.1 RC2* for Linux 64bit
- * Papyrus UML Light 0.0.1 RC2* for MacOS X 64bit
4. Click on the link for your development environment to download the archive
5. Extract the executable from the downloaded archive into the proper location for your operating system.
- Tip: On MacOS and some Linux, you may need to use “gunzip” followed by “tar xvf” to successfully extract the archive.
6. You are now ready to start using Papyrus UML Light!
Running Papyrus UMLLight
1. Double-click on the Papyrus UMLLight application you downloaded and installed.
2. A dialog is shown asking you to select a workspace.
About Workspaces
- Workspaces are folders on your computer where your models and associated files are stored.
1. Click on browse to select a folder that will hold your work.
2. Click “Launch” to start Papyrus UMLLight
3. The Papyrus UMLLight modeling environment's workspace is shown.
HERE
Palettes
- Palettes are the toolboxes of the Papyrus UMLLight modeling environment.
Palette Structure
Customized Palettes
In addition to the common tools, every Papyrus UMLLight diagram has a customized palette” containing the model elements that can be used with that diagram. You can think of it as your modeling “toolbox”. Each Papyrus UMLLight diagram’s palette is customized to meet the simplification goals of Papyrus UMLLight.
Diagram Palettes
Views of all the Papyrus UMLLight Palettes (in alphabetical order)
- But before we go further, let's have a look at the tutorial project so we can start implementing it!
Online Shopping System (OSS) Project Overview
The Online Shopping System (OSS) is a web-based system that allows customers to
- browse and search for products available in the catalogue and view their information;
- Add/remove products to/from a virtual shopping cart;
- View the content of the chopping cart;
- Purchase shopping cart products using a Credit or an online payment service (e.g., PayPal)
- Have the purchased items delivered.
Actors and use cases
Given these descriptions, we can deduce the following preliminary list of actors and use cases:
Actors | Customer | Product Manager | Payment Service | Product Database |
---|---|---|---|---|
Use Cases | Login | Add product | Accept Payment Request | Store product information |
Browse products | Remove product | Return payment status | Stores shopping carts | |
Add product to cart | Update product | |||
View Cart | List existing products | |||
Checkout |
We will further elaborate on this as we go through the creation of a model that will describes the OSS system.
Use Case Modeling
Use case modeling is about visualizing the environment and requirements of the system being built.
Therefore it is about about users, their needs, and how they interact with the system being built, as well as how the OSS system interacts with other systems.
Basic Use Case Diagram Concepts
Before We start, let's understand the main concepts of use case modeling.
Subject
The subject represents the system under consideration ("OSS" in our case) to which a set of use cases applies. As such, it also represents the boundary between our system and it's interactions with the "outside world." What is inside the subject constitutes the functionality of the system and what lies outside represent elements that interact with OSS, by providing input or services.
Actor
An Actor models a role played by an entity that interacts with the subject (e.g., by exchanging signals and data) but which is external to the subject, e.g., users accessing OSS or providing a service, e.g., an bank's payment service). As you can see, both people and external systems actors can be actors.
Use Case
A use case is the specification of a set of actions performed by the system, which yields observable results of value to one or more actors or other stakeholders of the system. { Adapted from UML Superstructure Specification, v2.4.1}.
Use cases are typically described as a sequence of steps. This sequence can be illustrated by using a sequence diagram to model the sequence of steps and can also be expressed textually (an example is provided a the end of this tutorial for those interested).
Relationships
The relationships that are available to you in Papyrus UMLLight can be found in the "Links" section of the use case diagram palette and consist of:
- Association
- * The association relationship is used to link actors to the use cases affected by them.
- * The association relationship, being bidirectional, does not indicate directionality and can therefore be draw in either direction.
- Generalization
- * The “Generalization” relationship is used to specify inheritance/generalization relationships between use cases or actors.
- * The relationship is drawn from the specialized entity to the general entity.
- Include: enable composition of use cases
- The include relationship is used to:
- * Simplify a use case by decomposing it into smaller use cases with the goal of increasing modularity and reusability.
- * The include relationship is drawn from the including element to the included element.
- * A use case "A" included in use case"B indicates that "B" requires "A" to accomplish its goals.
- Extend is used to specify an optional part of a use case
- * The extend relationship is drawn from the extender element to the extended element.
- * a use case "C" Extends use case "D" indicates that use case "C" is an optional part of use case D.
- Comment Link
- * The comment link is used to connect a comment to the element to which the comment applies.
Modeling the OSS Use Case
The time has come to get you modeling!
Create the OSS Project
1. First, you need to create a project For your OSS model:
2. From the menu, select “File >New UML Light Project” to create the OSS project
In the New UML Light Model Project" resulting dialog, set the project name to "OSS" and Notice that the model name is given the same name.
3. The dialog is shown.
4. Set the project name to "OSS" and Notice that the model name is given the same name.