Jump to: navigation, search

Papyrus User Guide


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


Create a Papyrus Package diagram from a EMF ECore UML model

How_to_get_a_EMF_Ecore_model_into_a_Papyrus_class_diagram

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

Working with Profiles

Externalized Profile Applications

Managing profile applications separately from the applying models

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

Existing Code Generation Facilities

Currently, Papyrus supports code generation for the following programming languages:

Upcoming Code Generation Facilities

Papyrus is going to support code generation for the following programming languages, which are in the experimental phase now, soon:

  • ADA code generation
  • C code generation

Adding a New Code Generator

Apart from the aforementioned programming language, it is also possible to develop and integrate other code generators to Papyrus. To learn about how to add a new code generator to Papyrus, refer to the following wikipage.

Reverse Engineering

Java Reverse Engineering

see Java reverse engineering

Documentation Support

Documentation Modelling

Documentation Generation

Deploy your applications

see Qompass for Papyrus

Fragment a Model

See Submodel Guide

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

Text alignment

See Text alignment

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

Embedded Editors

Papyrus provides embedded editors to edit UML Elements. Of course these editors allows to edit the name of the elements, but they allow to edit much more than this.

UML ValueSpecification editor

This editor allows to edit UMLValueSpecification. ValueSpecifications are used to define the default value of a Property or to define the multiplicity of a MultiplicityElement (lower and upper values). Papyrus provides an Xtext Editor for UML ValueSpecification. This editor provides completion (CTRL+SPACE) to help the user to define the value to set crossing easily the model.

You can use this editors in Papyrus table or in papyrus Property View for example.

The developer documentation for this editors is available here.

Usage

The default grammar of the XText parser for the Value Specification is the following:

(visibility)? (name'=')? value

The values accepted for the differents attributes are the following:

Attribute Required Values accepted
visibility No
  • + (public)
  • # (protected)
  • ~ (package)
  • - (private)
name No String representing an ID (i.e. XText grammar: '^'?('a'..'z'|'A'..'Z'|'_') ('a'..'z'|'A'..'Z'|'_'|'0'..'9')*)
value Yes
  • true or false (LiteralBoolean)
  • positive integer (LiteralUnlimitedNatural)
  • negative integer (LiteralInteger)
  • double (LiteralReal)
  • null (LiteralNull)
  • String with quote (LiteralSting). The quote (') is essential for 2 reasons:
    • The XText parser cannot define the difference between the name representing an InstanceSpecification and a simple string value
    • A Non-valid value won't be defined as an OpaqueExpression without quote but always as a LiteralString value
  • Instance Specification name (InstanceValue)
  • <Undefined> or empty (null)

If the text filled is not compatible with the grammar of XText parser, an OpaqueExpression will be created.


The XText parser for Value Specification is not restrictive with the text filled, i.e. the different features setted on an existing Value Specification will be kept if possible.

For example: If an existing Value Specification is a LiteralBoolean named 'testBoolean' with the visibility 'public' and the value setted to true, the text +testBoolean=false and false have the same result: the value of LiteralBoolean existing will pass to false (the name and the visilibity don't change).


The XText parser reacts differently instead of the type of the Value Specification's container:

Example: Without defined type on Value Specification's container

If the type of Value Specification's container is not defined, the default behaviour will be applied.

Here, some examples:

Text filled Namely Created ValueSpecification
Type Visibility Name Value
+testInstanceValue=InstanceSpec1 'InstanceSpec1' is an InstanceSpecification existing in the model InstanceValue public testInstanceValue 'instance' attribute of InstanceValue is a reference to the existing InstanceSpecification named 'InstanceSpec1'
No InstanceSpecification exist in the model OpaqueExpression public +testInstanceValue=InstanceSpec1
+testBoolean=true LiteralBoolean public testBoolean true
#testUnlimitedNatural=5 LiteralUnlimitedNatural protected testUnlimitedNatural 5
~testInteger=-8 LiteralInteger package testInteger -8
-testReal=12.34 LiteralReal private testReal 12.34
~testNull=null LiteralNull package testNull null
-testString="foo" LiteralString private testString foo
##testString="foo" OpaqueExpression public ##testString="foo"

Example: With defined type on Value Specification's container

If the type of Value Specification's container is setted, the same text filled will be have different behaviour depending to the type. In fact, the value filled must be consistent to the type, otherwise an OpaqueExpression will be created.

The different types corresponding to LiteralSpecification are the following:

LiteralSpecification Types corresponding
LiteralBoolean
  • JavaPrimitiveTypes::boolean
  • EcorePrimitiveTypes::EBoolean
  • EcorePrimitiveTypes::EBooleanObject
  • PrimitiveTypes::Boolean
  • XMLPrimitiveTypes::Boolean
  • XMLPrimitiveTypes::BooleanObject
LiteralUnlimitedNatural
  • PrimitiveTypes::UnlimitedNatural
LiteralInteger
  • JavaPrimitiveTypes::int
  • EcorePrimitiveTypes::EInt
  • EcorePrimitiveTypes::EIntegerObject
  • PrimitiveTypes::Integer
  • XMLPrimitiveTypes::Int
  • XMLPrimitiveTypes::Integer
  • XMLPrimitiveTypes::IntObject
LiteralReal
  • JavaPrimitiveTypes::double
  • EcorePrimitiveTypes::EDouble
  • EcorePrimitiveTypes::EDoubleObject
  • PrimitiveTypes::Real
  • XMLPrimitiveTypes::Double
  • XMLPrimitiveTypes::DoubleObject
LiteralString
  • EcorePrimitiveTypes::EString
  • PrimitiveTypes::String
  • XMLPrimitiveTypes::String

Here, some examples:

Text filled Value Specification's container type Created ValueSpecification
Type Visibility Name Value
+testBoolean=true PrimitiveTypes::Boolean LiteralBoolean public testBoolean true
PrimitiveTypes::Integer OpaqueExpression public +testBoolean=true
-testUnlimitedNatural=8 PrimitiveTypes::UnlimitedNatural LiteralUnlimitedNatural private testUnlimitedNatural 8
PrimitiveTypes::Integer LiteralInteger private testUnlimitedNatural 8
PrimitiveTypes::Real LiteralReal private testUnlimitedNatural 8.0
PrimitiveTypes::Boolean OpaqueExpression public -testUnlimitedNatural=8
#testInteger=-6 PrimitiveTypes::UnlimitedNatural OpaqueExpression public #testInteger=6
PrimitiveTypes::Integer LiteralInteger protected testInteger 6
PrimitiveTypes::Real LiteralReal protected testInteger 6.0
PrimitiveTypes::Boolean OpaqueExpression public #testInteger=6
-testReal=4.5 PrimitiveTypes::Integer OpaqueExpression public -testReal=4.5
PrimitiveTypes::Real LiteralReal private testReal 4.5

Textual Editor For Named Element

Since Papyrus 1.1.0 (Eclipse Mars), Papyrus provides a new texutal editor to edit references to UML NamedElement. This editor works only for references which are not in containment. This editor has not been developed using XText. It use a custom string parser and provide a completion (CTRL+SPACE) to help the user to find the named elements to reference in the model.

You can use this editor in Property View or in Papyrus table for example. Developer documentation is available here.

Usage

  • This editors allows to find named element typing its name.
  • In case of several elements to found, the separator to use is the comma </code>'</code>
  • If the name of the element contains a comma, you should prefix and suffix its name by a quote '.
  • The value will not be set if the element can't be found is the model

Example

If you have 3 Classes in your model, named Class1, Class2 and Clas,s3.

typed text completion proposal explanation
empty string <Undefined>, ... we look for nothing, so we provide the <Undefined> value and ... to ask to the user to write more text
Clas <Undefined>,Class1,Class2,Clas,s3 3 classes matches the string, <Undefined> is always proposed
Class <Undefined>,Class1,Class2 3 classes matches the string, <Undefined>is always proposed
'Clas <Undefined>, Clas,s3 the string starts with a quote and Clas,s3 contains a comma, so we propose Clas,s3; <Undefined> is always proposed
Clas, <Undefined>,... interpreted as a list of value, the first value is </code>Clas</code>, and we have no information for the second one, for the completion it is an empty string

Property View

Appearence Tab

Shape Customization

To be defined

Stereotype Display

See Stereotype Display via Property View

Multiplicity Editor

Description

The multiplicity editor contains two modes of edition:

  • The simple mode which allows to edit the lower and the upper values from a unique editor
  • The advanced mode which allows to edit the lower and the upper values from two editors of ValueSpecification.

Usage

Simple mode

The simple mode is represented as the following:

SimpleMode.png

This editor must be filled by the following pattern:

Value filled Lower value Upper value
1 null (default value is 1) null (default value is 1)
x..y LiteralInteger with value x LiteralUnlimitedNatural with value y
x..* LiteralInteger with value x LiteralUnlimitedNatural with value -1 (interpreted as *)
x LiteralInteger with value x LiteralUnlimitedNatural with value x

The values set as lower and upper are always positive (except the * for the upper which is valued as -1).

This editor is usable only when the lower ValueSpecification is a LiteralInteger or null and when the upper ValueSpecification is a LiteralUnlimitedNatural or null. On the other hand, this editor will be displayed like the following:

SimpleModeDisabled.png

Advanced mode

Simple ValueSpecification editor

The advanced mode with simple ValueSpecificatiton editors is represented as the following:

AdvancedMode.png

The lower and the upper ValueSpecification can be created/edited/deleted by the buttons:

ButtonsEdit.png

XText ValueSpecification editor

The advanced mode with XText ValueSpecification editors is represented as the following:

AdvancedModeXText.png

This editor use the XText ValueSpecification editors (explain here) with some specificities depending on lower or upper value edition.

The specificity of the lower ValueSpecification edition is when the value filled is an integer, this one will be handled as LiteralInteger instead of LiteralUnlimitedNatural or LiteralInteger (the * value will create an OpaqueExpression).

The specificity of the upper ValueSpecification edition is when the value filled is an integer or *:

  • if the integer is positive or -1, a LiteralUnlimitedNatural will be created
  • if the integer is negative, an OpaqueExpression will be created instead of LiteralInteger

Switch modes

This is possible to switch between the two modes by two ways:

  • The button in the multiplicity editor:

ButtonSwitch.png

  • The multiplicity editor preferences in the property views preferences:

PreferencesMultiplicityEditor.png

Regarless of the way used to switch modes, the mode used is saved in the preferences and will be used for each multiplicity in Papyrus.