Papyrus ¶

Papyrus is an open-source UML tool based on Eclipse. It's a multipurpose software allowing us to:

• 🤔 Design UML 2 diagrams
• 🏭 Generate code from diagrams
• 🛣️ Simulate your diagrams
• 👀 Connect diagrams and write meta-models
• ...

You can download it here. These notes are based on 4.8.0.

To install Papyrus, you need to install Java first. If you have problems when starting Papyrus, check out this video.

Once the software is started, create a new papyrus model. A model is made of 3 files: xxx.di, xxx.notation, and xxx.uml.

⚠️ Their software may be buggy at times and crash. Make sure to often save your diagrams and keep copies of your work.

Model ¶

All diagrams are parts of a model. It allows us to connect diagrams and reuse what we defined in other diagrams between diagrams.

If you change the model, it will be changed everywhere.

View and model ¶

The Model explorer is the only thing you can trust.

The view may change and the model may not. It may occur if you try to rename something and the new name is invalid.

Perspectives ¶

Perspectives allow you to view your model from different perspectives. Ensure that you are using the Papyrus perspective when you are creating models.

If you use a perspective at least once, a shortcut will be available right next to the perspective menu. See also: "Window > Perspective".

Don't scroll in the property view ¶

You can scroll to change the values of a field (such as checked -> uncheck, or the type of your attribute, etc.) when you are in the Property view.

Unfortunately, you can't control it: you might change something or cancel everything you did by mistake ⚠️.

Modified file symbol ¶

It's common, but there is a little star before every edited filename.

Icons for Palette ¶

The palette has quite a lot of elements. It's faster and easier to change the palette view to a list of icons (Right-click to change the view).

Dark Mode ¶

Navigate to Window > Preferences and set your settings.

Fast creation of items ¶

From the palette, you can double-click on something to create a new element, there is no need to drag-and-drop it.

Align items ¶

It's kind of useless, but to create nicer diagrams, you may use "align" to cleanly arrange items in a diagram.

Either by using this icon or CTRL+{some arrow}, after selecting elements, you can align every class based on the position of the last selected class. You can use "distribute" too.

Associations ¶

When selecting an association, directed associations are created by default. After using an undirected association, it will use these.

After creating an association, in the Property view you can add a direction, set the multiplicity, transform it into a composition or aggregation, etc. rather easily.

Wait a bit while your mouse is on top of a class, and a shortcut to create associations will pop up:

Interfaces ¶

As a reminder:

• ➡️ If a class implements/realizes an interface, then the head of the arrow is on the interface.
• ➡️ If a class extends/generalizes another class, then the head of the arrow is on the other class.

Layout/Appearance ¶

You can right-click on a class:

• Reformat: reformat what you selected
• Filter: show/hide attributes/operations/...
• You can also give colors to classes
• ...

Types ¶

When clicking on an attribute, there is a field "Type" inside the Property View. Click on "... > Tree > EPackage Primitive Types" and select your type.

Notes

• "Boolean [1]" after the type means that the cardinality is 1 (=this is a value, more than 1 means this is an array/a list/a queue/...)
• You could drag and drop a class inside the field, instead of picking a primitive type.
• If you need to create a new type, use either DataType (cannot be instanced) or Primitive type or a class if none are what you want

External Types

In Java, you may use classes such as java.util.Arrays in your diagrams. ⚠️ It's complicated to do it properly.

Install dependencies ¶

You need papyrus.designer, Xtend IDE, and acceleo.

You'll then have to download a plugin for code generation:

Improve the generation ¶

[for (p : Package | aModel.nestedPackage->sortedBy(name))]
	[comment DONE then display Package's name/]
	Package [p.name/]
	[comment DONE and indent classes and interfaces names/]
	[for (c : Class | p.packagedElement->filter(Class)->sortedBy(name))]
		[generateClassElement(c)/]
	[/for]
	[for (i : Interface | p.packagedElement->filter(Interface)->sortedBy(name))]
		[generateInterfaceElement(i)/]
	[/for]
[/for]

[**
 * Generates the type in Java given an OCL type
 * @param aType The OCL Type
 */]
[template public genType(aType : String)]
[if (aType.toUpperFirst() = 'Real')]Float[else][aType.toUpperFirst()/][/if]
[/template]

// import
// import org.eclipse.papyrus.designer.languages.common.profile.Codegen.NoCodeGen;
EList<Classifier> usedClassesReturn = new UniqueEList<Classifier>();
for(Classifier c : usedClasses) {
	if (!GenUtils.hasStereotypeTree(c, NoCodeGen.class)) {
		usedClassesReturn.add(c);
	}
}

- GenUtils.hasStereotypeTree(element, ExternLibrary.class) ||
+ GenUtils.hasStereotypeTree(element, ExternLibrary.class) &&
+ GenUtils.hasStereotypeTree(element, NoCodeGen.class);

// todo
return false;

- JavaGenUtils.javaQualifiedName(operation.type, operation.owner) + ' ' 
+ JavaGenUtils.javaQualifiedName(operation.type, operation.owner).toFirstUpper() + ' '

- «IF mustGenerateBody(operation)»«JavaOperations.javaOperationImplementation(operation)»«ENDIF»
+ «IF mustGenerateBody(operation)»«JavaOperations.javaOperationImplementation(operation)»
+ «IF javaReturnSpec(operation) != 'void ' && !isConstructor(operation)»return null;«ENDIF»«ENDIF»

[template public genDefaultImport(aType : Type)]
// [protected ('for imports')]
import java.util.*;
// [/protected]
[/template]

[template private packagePath(aType : Type)]
- [ /* something */ /]
+ ['/' + aType.getSourcePackage() + '/' + /* something */ /]
[/template]

[template public genPackageValue(aType : Type)]
- [ /* something */ /]
+ [aType.getSourcePackage() + '.' + /* something */ /]
[/template]

[template public getSourcePackage(aType : Type)]
[aType.getModel().name/]
[/template]

- [for (anOperation : Operation | aClass.getOperations()->union(aClass.getImplementedInterfaces().ownedOperation))]
+ [for (anOperation : Operation | aClass.getOperations())]

[let c : Classifier = aClass.oclAsType(Classifier)]
[if (c.getAppliedStereotypes()->collect(name)->count('External') = 0)]
[/if]
[/let]

Runtime Eclipse ¶

• Run > Run Configurations (or Debug Configurations)
• Double-click on Eclipse
• You may name the configuration "runtime_eclipse"
• Press Run (resp. Debug)
• And click on proceed if prompted.

Process With Code Generation ¶

Inside the Runtime Eclipse:

• Import projects
• Existing Projects Into Workspace
• Browse > Find SMModel
• Once imported, double-click on the model

For Xtend 🍬, in the Model Explorer:

• Right-click on "Project XXX" (your project)
• Generate Code for State Machine
• Create JDT (Yes > Set JDK to XXX > Finish)

For Acceleo 🍫, in the Project Explorer:

• Expand "Project XXX" (your project) to see the UML file
• Right-click on the UML file
  • Acceleo Model To Text
  • Generate UML2java
• You got a folder src-gen

It will generate a new model with the generated Java classes 👑.

• Papyrus CEA Guide
• Warning: do not create an activity twice (use sync with editor, navigate to find it)
• Warning: in activities, every call must be Typed