Deutsch      Español      Français      日本語      한국어      Русский      中文

Translation support

You can click here to access the wiki and update the translation.

You can go back to the translated webpage.

To help you in the translation process, here is a comparison with the English version :

Anwendungsfall Diagramm-Syntax und Funktionen

PlantUML Anwendungsfalldiagramm-Syntax: Sie können Fälle, Akteure, Erweiterungen, Notizen, Stereotypen, Pfeile verwenden ... Ändern von Schriften und Farben ist auch möglich.

Use case Diagram syntax and features

PlantUML use case diagram syntax: You can have use cases, actors, extensions, notes, stereotypes, arrows... Changing fonts and colors is also possible.

 

Anwendungsfall-Diagramm

Let's have few examples :

Note that you can disable the shadowing using the skinparam shadowing false command.

 

Use Case Diagram

Let's have few examples :

 

Anwendungsfälle

Anwendungsfälle sind von zwei Klammern eingeschossen (da zwei Klammern wie ein Oval aussehen).

Alternativ kann man das usecase Schlüsselwort verwenden, um einen Anwendungsfall zu definieren. Außerdem ist es möglich, einen Alias mit dem as Schlüsselwort zu definieren. Dieser Alias wird dann verwendet wenn die Beziehungen festgelegt werden.

@startuml

(First usecase)
(Another usecase) as (UC2)  
usecase UC3
usecase (Last\nusecase) as UC4

@enduml

 

Usecases

Use cases are enclosed using between parentheses (because two parentheses looks like an oval).

You can also use the usecase keyword to define a usecase. And you can define an alias, using the as keyword. This alias will be used latter, when defining relations.

@startuml

(First usecase)
(Another usecase) as (UC2)  
usecase UC3
usecase (Last\nusecase) as UC4

@enduml

 

Akteure

Die Namen von Akteuren werden von zwei Doppelpunkten umschlossen.

Mann kann aber auch das actor Schlüsselwort verwenden um einen Akteur zu definieren. Außerdem ist es möglich, mit dem as Schlüsselwort einen Alias festzulegen. Dieser Alias wird dann später verwendet, wenn die Beziehungen festgelegt werden.

Wie wir sehen werden, ist die Definition eines Akteur nicht zwingend notwendig.

@startuml

:First Actor:
:Another\nactor: as Men2  
actor Men3
actor :Last actor: as Men4

@enduml

 

Actors

Actor are enclosed using between two points.

You can also use the actor keyword to define an actor. And you can define an alias, using the as keyword. This alias will be used latter, when defining relations.

We will see later that the actor definitions are optional.

@startuml

:First Actor:
:Another\nactor: as Men2  
actor Men3
actor :Last actor: as Men4

@enduml

 

Beschreibung der Anwendungsfälle

Falls sich eine Beschreibung über mehrere Zeilen ersterckt, kann diese mit Anführungsstrichen eingeschlossen werden.

Außerdem kann man die folgenden Seperatoren verwenden: --..==__. Außerdem kann man Überschriften innerhalb der Seperatoren verwenden.

@startuml

usecase UC1 as "You can use
several lines to define your usecase.
You can also use separators.
--
Several separators are possible.
==
And you can add titles:
..Conclusion..
This allows large description."

@enduml

 

Usecases description

If you want to have description on several lines, you can use quotes.

You can also use the following separators: --..==__. And you can put titles within the separators.

@startuml

usecase UC1 as "You can use
several lines to define your usecase.
You can also use separators.
--
Several separators are possible.
==
And you can add titles:
..Conclusion..
This allows large description."

@enduml

 

Einfaches Beispiel

Um Akteure und Anwendungsfälle miteinander zu verbinden wird der Pfeil --> verwendet

Je mehr Bindestriche - der Pfeil enthält, desto länger wird der Pfeil. Mit einem Doppelpunkt : kann dem Pfeil eine Beschreibung hinzugefügt werden.

In diesem Beispiel kann man sehen, wie ein vorher nicht deklarierter User automatisch als Akteur deklariert wird.

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

 

Basic example

To link actors and use cases, the arrow --> is used.

The more dashes - in the arrow, the longer the arrow. You can add a label on the arrow, by adding a : character in the arrow definition.

In this example, you see that User has not been defined before, and is used as an actor.

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

 

Erweiterungen / Generalisierungen

Wenn ein Akteur oder Anwendungsfall einen anderen erweitert, dann kann dies mit dem Symbol <|--.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User <|-- Admin
(Start) <|-- (Use)

@enduml

 

Extension

If one actor/use case extends another one, you can use the symbol <|--.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User <|-- Admin
(Start) <|-- (Use)

@enduml

 

Verwenden von Notizen

Mit den note left of , note right of , note top of , note bottom of Schlüsselwörtern kann man die Position der Notiz relativ zum Objekt festlegen.

Eine Notiz kann aber auch nur mit dem note Schlüsselwort erstellt werden und dann mit dem .. Symbol den Objekten zugeordnet werden.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User -> (Start)
User --> (Use)

Admin ---> (Use)

note right of Admin : This is an example.

note right of (Use)
  A note can also
  be on several lines
end note

note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml

 

Using notes

You can use the note left of , note right of , note top of , note bottom of keywords to define notes related to a single object.

A note can be also define alone with the note keywords, then linked to other objects using the .. symbol.

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User -> (Start)
User --> (Use)

Admin ---> (Use)

note right of Admin : This is an example.

note right of (Use)
  A note can also
  be on several lines
end note

note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml

 

Stereotypen

Stereotypen könne während der Erstellung der Akteure und der Anwendungsfälle mit den << und >> Symbolen hinzugefügt werden .

@startuml
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

 

Stereotypes

You can add stereotypes while defining actors and use cases using << and >>.

@startuml
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

 

Ändern der Pfeilrichtungen

Normalerweise haben die Verbindungen zwischen den Klassen zwei Striche -- und werden senkrecht gezeichnet. Es ist aber möglich waagerechte Verbindungen zu erstellen in dem man einen einzelnen Strich (oder Punkt) eingibt:

@startuml
:user: --> (Use case 1)
:user: -> (Use case 2)
@enduml

Sie können auch die Richtung der Verlinkung umkehren:

@startuml
(Use case 1) <.. :user:
(Use case 2) <- :user:
@enduml

Die Richtung der Pfeile kann man durch das hinzufügen der left, right, up oder down Schlüsselworte im Pfeil bestimmen:

@startuml
:user: -left-> (dummyLeft) 
:user: -right-> (dummyRight) 
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml

Man kann die Pfeile verkürzen, wenn man nur den ersten Buchstaben für die Richtung verwendet (zum Beispiel, -d- anstelle von -down-) oder man nimmt die ersten beiden Buchstaben (-do-).

Diese Möglichkeit sollte aber nicht missbraucht werden: GraphViz liefert normalerweise recht gute Ergebnisse, ohne das manuell eingeriffen werden muss.

 

Changing arrows direction

By default, links between classes have two dashes -- and are vertically oriented. It is possible to use horizontal link by putting a single dash (or dot) like this:

@startuml
:user: --> (Use case 1)
:user: -> (Use case 2)
@enduml

You can also change directions by reversing the link:

@startuml
(Use case 1) <.. :user:
(Use case 2) <- :user:
@enduml

It is also possible to change arrow direction by adding left, right, up or down keywords inside the arrow:

@startuml
:user: -left-> (dummyLeft) 
:user: -right-> (dummyRight) 
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml

You can shorten the arrow by using only the first character of the direction (for example, -d- instead of -down-) or the two first characters (-do-).

Please note that you should not abuse this functionality : Graphviz gives usually good results without tweaking.

 

Aufteilen von Diagrammen auf mehrere Seiten

Mit dem Befehl newpage kann das Diagramm auf mehrere Seiten oder Bilder verteilt werden.

@startuml
:actor1: --> (Usecase1)
newpage
:actor2: --> (Usecase2)
@enduml

 

Splitting diagrams

The newpage keywords to split your diagram into several pages or images.

@startuml
:actor1: --> (Usecase1)
newpage
:actor2: --> (Usecase2)
@enduml

 

Verändern der Richtung in der die Objekte angeordnet werden

Das voreingestellte verhalten bei der Erstellung des Diagramms ist von oben nach unten.

@startuml
'default
top to bottom direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml
Dies lässt sich aber durch die Verwendung des left to right direction Befehls verändern. Oft ist das Ergebnis mit dieser Einstellung besser.

@startuml

left to right direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

 

Left to right direction

The general default behavior when building diagram is top to bottom.

@startuml
'default
top to bottom direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml
You may change to left to right using the left to right direction command. The result is often better with this direction.

@startuml

left to right direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)

@enduml

 

Der Skinparam-Befehl

Mit dem skinparam Befehl kann die Farbe und die Schriftart der Zeichnung verändert werden.

Sie können den Befehl auf die folgenden Arten verwenden:

Man kann bestimmte Farben und Schriften für Klassen von Akteuren und Anwendungsfälle festlegen.

@startuml
skinparam handwritten true

skinparam usecase {
	BackgroundColor DarkSeaGreen
	BorderColor DarkSlateGray

	BackgroundColor<< Main >> YellowGreen
	BorderColor<< Main >> YellowGreen
	
	ArrowColor Olive
	ActorBorderColor black
	ActorFontName Courier

	ActorBackgroundColor<< Human >> Gold
}

User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

 

Skinparam

You can use the skinparam command to change colors and fonts for the drawing.

You can use this command :

You can define specific color and fonts for stereotyped actors and usecases.

@startuml
skinparam handwritten true

skinparam usecase {
	BackgroundColor DarkSeaGreen
	BorderColor DarkSlateGray

	BackgroundColor<< Main >> YellowGreen
	BorderColor<< Main >> YellowGreen
	
	ArrowColor Olive
	ActorBorderColor black
	ActorFontName Courier

	ActorBackgroundColor<< Human >> Gold
}

User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>

User -> (Start)
User --> (Use)

MySql --> (Use)

@enduml

 

Vollständiges Beispiel

@startuml
left to right direction
skinparam packageStyle rectangle
actor customer
actor clerk
rectangle checkout {
  customer -- (checkout)
  (checkout) .> (payment) : include
  (help) .> (checkout) : extends
  (checkout) -- clerk
}
@enduml

 

Complete example

@startuml
left to right direction
skinparam packageStyle rectangle
actor customer
actor clerk
rectangle checkout {
  customer -- (checkout)
  (checkout) .> (payment) : include
  (help) .> (checkout) : extends
  (checkout) -- clerk
}
@enduml

This page is generated once per day from the wiki content.

Quantcast