Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus User Guide"

(Constraints in Papyrus)
(Toolbars)
(32 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
-->  
 
-->  
  
= Using UML modeling editors  =
+
= Using modeling editors  =
  
 
== UML modeling  ==
 
== UML modeling  ==
Line 128: Line 128:
 
=== Constraints in Papyrus ===
 
=== Constraints in Papyrus ===
  
==== Create and edit constraints =====
+
==== Create and edit constraints ====
  
===== Define a constraint and its context =====
+
[[Papyrus/UserGuide/Papyrus Constraints|Create and edit constraints]]
 
+
Papyrus supports the creation of UML constraints. To create a constraint, and associated context, do one of the following:
+
 
+
* Within any Papyrus diagram select the constraint tool from the palette and then press the mouse button at the position where you want to create the constraint on the diagram canvas. The constraint should then be connected to another element on the diagram, via a ContextLink relationship, by clicking on the target element in the diagram (in two-click mode). If you are in one-click-mode (connection tool preference), press the mouse button on the constraint and keep it pressed until the context object is selected. This ContextLink relationship defines the context for which the constraint will be evaluated.
+
 
+
<center>
+
[[Image:Constraint_CreateViaDiagram.png]]&nbsp;&nbsp;&nbsp;[[Image:Constraint_ContextViaDiagram.png]]<br>
+
The constraint and context-link tools in the palette
+
</center>
+
 
+
* Within the Model Explorer via right clicking a model element and then selecting New Child -> Create a new Constraint. The context is automatically set to the parent of the constraint. The context can be changed via the Properties View if required.<br>
+
 
+
<center>
+
[[Image:Constraint_CreateViaME.png]]<br>
+
Create a constraint via the model explorer
+
</center>
+
 
+
<center>
+
[[Image:Constraint_ContextViaPropertyView.png]]<br>
+
Set the context via the property view
+
</center>
+
 
+
===== Define constraint specification =====
+
 
+
Each constraint has a specification containing a condition. Whereas it may be an arbitrary value specification, such as a StringExpression or LiteralInteger, it is in most cases useful to define an opaque expression consisting of a pair of language and body (a list of these pairs). The constraint body may be written in at least OCL, JAVA, or natural language. In order to make constraints evaluable by Papyrus the constraint must be written in either OCL or JAVA. To define a constraint's specification, first select a constraint on either a diagram or in the Model Explorer, then do the following:
+
 
+
* On the diagram open the default editor for constraints using the keyboard shortcut F2 or with a second click on an already selected constraint. The editor assume the language is OCL but this can be changed later via the Properties View. The constraint text is defined directly in the editor. The default editor can be controlled via the preferences.
+
 
+
* On the diagram select a specific editor via the context menu, as shown in the following screenshot.
+
 
+
<center>
+
[[Image:Constraint_ChooseEditor.png]]<br>
+
Explicitly choose the editor for the constraint
+
</center>
+
 
+
Use the property view to create a new or open an existing specification, as shown in the following figure.
+
In the sequel, we assume that the specification is an opaque expression.
+
 
+
<center>
+
[[Image:Constraint_SpecViaPropertyView.png]]<br>
+
Open the specification via the property view
+
</center>
+
 
+
You can add the language, as in the following figure:<br>
+
 
+
<center>
+
[[Image:Constraint_OpaqueExpressionAddLang.png]]<br>
+
Specify a language.
+
</center>
+
 
+
<center>
+
[[Image:Constraint_OpaqueExpressionEdit.png]]<br>
+
Write the body of the opaque expression
+
</center>
+
 
+
This method is a bit more complicated, but gives the user full control over the opaque specification. In particular,
+
it is possible to enter more than one language, body pair (even if this is rarely needed).
+
  
 
==== Validate OCL Constraints of a Profile ====
 
==== Validate OCL Constraints of a Profile ====
  
Papyrus supports an additional profile for defining Domain Specific Modeling Languages (DSML) that refines how constraints are validated.
+
[[Papyrus/UserGuide/Profile Constraints|Define Profile Constraints]]
The additional profile enables a more precise specification of validation properties, for example:
+
•Mode: Defines if the validation of the constraint is done in “batch” or “live” mode
+
•Severity: Defines the severity of the constraint violation. It can be one of INFORMATION, WARNING or ERROR. The latter is the default severity (if none is specified). The CANCEL severity should be used with caution, as it causes the validation operation to be interrupted, possibly resulting in the loss of valuable diagnostic information from other constraints.
+
•Message: Defines the message that will be displayed if the constraint is violated
+
•Description: Provides a description of the constraint •Enabled by default: Defined if this constraint should be enabled by default or not
+
 
+
CAVEAT: The information added via the profile using the DSML profile is not currently taken into account during OCL validation. The support will be added soon.
+
 
+
Advanced users can also define:
+
• Id: The constraint id
+
• Status code: The plug-in unique status code, useful for logging.
+
•The target of validation, the element to be validated
+
 
+
How to apply the DSML validation profile:
+
1.Select the profile root and apply the profile
+
 
+
2.Select the profile tab in the property view
+
 
+
3.Click on the registered profile button
+
 
+
4.Select the "DSML Validation" profile
+
 
+
<center>
+
[[Image:DSML-profileApplication.png]]<br>
+
Open the specification via the property view
+
</center>
+
 
+
5.Select the constraint
+
 
+
6.Select the profile tab of the property view
+
7.Click on the apply profile button
+
8.Select the ValidationRule stereotype
+
 
+
<center>
+
[[Image:DSML-stereotypeApplication.png]]<br>
+
Open the specification via the property view
+
</center>
+
 
+
You can then edit the stereotype attribute to define information about the behavior of the validation.
+
 
+
===== Generation from Constraints =====
+
 
+
Constraints expressed in OCL can be validated directly in the tool. This is not the case for Java constraints which must be placed in a suitable plugin. However, Papyrus supports the generation of this plugin.
+
 
+
Generate constraints directly into the definition
+
 
+
Constraints written in OCL within the profile can be generated into the definition of the profile and read during the validation of the model.
+
 
+
How to
+
 
+
When you save the profile, Papyrus asks to you if want to define the profile.
+
Click on yes and then assure that the "Save OCL constraint into the definition" button is active (which is the case by default)
+
  
 
== SysML Modeling  ==
 
== SysML Modeling  ==
Line 294: Line 185:
 
== Layer Support  ==
 
== Layer Support  ==
 
See [[Papyrus/UserGuide/Layers|Layers Guide]]
 
See [[Papyrus/UserGuide/Layers|Layers Guide]]
 +
 +
== Model Execution ==
 +
[[Papyrus/UserGuide/ModelExecution|Execute your fUML models with MOKA]]
  
 
== Automatic Layout Support  ==
 
== Automatic Layout Support  ==
Line 300: Line 194:
  
 
=== JAVA Code Generation  ===
 
=== JAVA Code Generation  ===
 +
see [http://wiki.eclipse.org/Java_Code_Generation Java code generation]
  
 
=== C/C++ Code Generation  ===
 
=== C/C++ Code Generation  ===
  
see [http://wiki.eclipse.org/Codegen_description Papyrus C++ code generation]
+
see [http://wiki.eclipse.org/Papyrus/Codegen/Cpp_description Papyrus C++ code generation]
  
 
=== ADA Code Generation  ===
 
=== ADA Code Generation  ===
 +
 +
== Reverse Engineering ==
 +
 +
=== Java Reverse Engineering ===
 +
 +
see [http://wiki.eclipse.org/Java_reverse_engineering Java reverse engineering]
  
 
== Documentation Support  ==
 
== Documentation Support  ==
Line 313: Line 214:
 
=== Documentation Generation ===
 
=== Documentation Generation ===
  
 +
== Deploy your applications ==
 +
 +
see [http://wiki.eclipse.org/Papyrus_Qompass Qompass for Papyrus]
 +
 +
[[Category:Papyrus]]
 +
 +
= General Feature =
 +
 +
== Editors ==
 +
=== Palette ===
 +
The palette is available with any diagrams. But its content depends on the diagrams type.
 +
The standard palette ( the top container of the palette in red in the here-after capture) contents a standard selection tool (the white arrow), a zoom in and zoom out tool, and marquee selection tools.<br/>
 +
[[File:Palette1.JPG]] <br/>
 +
The standard palette is available for every diagram.
 +
==== Properties ====
 +
 +
See [http://wiki.eclipse.org/Papyrus_User_Guide/Palette/Properties Properties]
 +
 +
==== Standard Selection tool ====
 +
 +
See [http://wiki.eclipse.org/Papyrus_User_Guide/Palette/Standard_Selection_Tool Standard selection Tool]
 +
 +
==== Zoom Tools ====
 +
See [http://wiki.eclipse.org/Papyrus_User_Guide/Palette/Zoom_Tools Zoom Tools]
 +
 +
==== Marquee Selection Tools====
 +
See [http://wiki.eclipse.org/Papyrus_User_Guide/Palette/Marquee_Selection_Documentation Marquee Selection Tool]
 +
 +
=== Toolbars ===
 +
Papyrus has its own set of Toolbars. A Toolbar regroups a set of tools belonging to the same kind of activity.
 +
The different Toolbars can be shown or hide depending on the perspectives. <br/>
 +
The toolbars visibility can be customized from the menu Windows/Customize Perspectives. <br/>
 +
[[File:Customize_Perspective.JPG|frame|center|Alignment Perpective]]
 +
 +
==== Alignment ====
 +
See [http://wiki.eclipse.org/Papyrus_User_Guide/Toolbars/Alignment Alignment]
 +
 +
--[[User:Celine.Janssens.all4tec.net|Céline Janssens &#91;ALL4TEC&#93;]] ([[User talk:Celine.Janssens.all4tec.net|talk]]) 12:06, 28 August 2014 (EDT)
 
[[Category:Papyrus]]
 
[[Category:Papyrus]]

Revision as of 12:06, 28 August 2014


Contents

Using modeling editors

UML modeling

Getting Started

Papyrus Perspective

The Papyrus perspective contains :

  • Model Explorer view
  • Outline view
  • Multi diagram editor view
  • Properties view
  • Toolbar

Papyrus Perspective.png

Model Explorer View

The model explorer is used to navigate to the all model's elements and the diagrams.

Papyrus ModelExplorer.png

This action link the model explorer with the active diagram selection. This action works bidirectionally.

Papyrus ME Sync.png

This action allow to add new semantic element.

Papyrus ME NewChild.png

This action allow to add new diagram in current selection.

Papyrus ME NewDiagram.png

All actions are available on diagram item.

Papyrus ME DiagramMenu.png

The model explorer used Common Navigator Framework and provide facilities to customize view.

Papyrus ME CustomizeView.png

To customize the content of treeViewer:

Papyrus ME CustomizeView Content.png

To filter the content of treeViewer:

Papyrus ME CustomizeView Filters.png

Outline View

The Outline offers a thumbnail of the graphical representation and the list of semantic elements used in current diagram.

Papyrus OutLine.pngPapyrus OutLine All.pngPapyrus OutLine Tree.png

Tutorials on UML modeling with Papyrus

Model/Diagram creation wizard

Create a new Model.

Papyrus CreateNewModel.png


Choose the model file name and the first diagram to create.

Papyrus CreateNewModel-2.png Papyrus CreateNewModel-3.png

Create a diagram from an existing uml file

From your uml file, select the "Initialize Papyrus diagram" to access the creation wizard of Papyrus. Your Papyrus diagram will be linked with your existing model.

CreateDiagramFromModel.PNG


Apply a static profile
  • 1 - Select a package element (ie a Model or a Package).
  • 2 - Select the tab "Profile" on the "Properties" view
  • 3 - Click on the plug-in icon
  • 4 - Select your static profile
  • 5 - Choose profiles to apply

PapyrusApplyStaticProfil.PNG

Load an additionnal resource
Show additional resources in your model explorer view

Ensure that the filter for the additional resources is not checked on your model explorer view : PapyrusFilterAdditionalResources.PNG

Add an additional resource

Right click on an element of your model and select the menu "Load resource..."

PapyrusLoadResources.PNG


Table Documentation

See http://wiki.eclipse.org/Papyrus_User_Guide/Table_Documentation

Papyrus Zoo of UML Models

Composite Structure Diagram

CompositeSupport.PNG

The project is available here [1]

Constraints in Papyrus

Create and edit constraints

Create and edit constraints

Validate OCL Constraints of a Profile

Define Profile Constraints

SysML Modeling

Tutorials on SysML modeling with Papyrus

Papyrus Zoo of SysML Models

MARTE Modeling

Tutorials on MARTE modeling with Papyrus

Papyrus Zoo of MARTE Models

fUML and Alf Modeling

Using fUML and Alf to produce executable models

Developing custom DSL based editor with Papyrus

UML Profile Modeling

Define Profile Constraints

MetaModel Modeling

Additional Editor Integration (this section is for the Backone)

Diagram Editors Customizations

Specific Diagram Editors Creation

Diagram Editor Palette Customization

Here you can find the documentation describing palette customization: Doc

This document can also be found in Papyrus help section => User Guide => Palette customization

Property Editor Customization

Model Explorer Customization

Diagram Appearance Customization with CSS Stylesheets

CSS Stylesheets in Papyrus

Additional Utilities of Papyrus

Collaborative Work Support

Layer Support

See Layers Guide

Model Execution

Execute your fUML models with MOKA

Automatic Layout Support

Code Generation Support

JAVA Code Generation

see Java code generation

C/C++ Code Generation

see Papyrus C++ code generation

ADA Code Generation

Reverse Engineering

Java Reverse Engineering

see Java reverse engineering

Documentation Support

Documentation Modelling

Documentation Generation

Deploy your applications

see Qompass for Papyrus

General Feature

Editors

Palette

The palette is available with any diagrams. But its content depends on the diagrams type. The standard palette ( the top container of the palette in red in the here-after capture) contents a standard selection tool (the white arrow), a zoom in and zoom out tool, and marquee selection tools.
Palette1.JPG
The standard palette is available for every diagram.

Properties

See Properties

Standard Selection tool

See Standard selection Tool

Zoom Tools

See Zoom Tools

Marquee Selection Tools

See Marquee Selection Tool

Toolbars

Papyrus has its own set of Toolbars. A Toolbar regroups a set of tools belonging to the same kind of activity. The different Toolbars can be shown or hide depending on the perspectives.
The toolbars visibility can be customized from the menu Windows/Customize Perspectives.

Alignment Perpective

Alignment

See Alignment

--Céline Janssens [ALL4TEC] (talk) 12:06, 28 August 2014 (EDT)

Back to the top