PlantUML Language specification Activity Diagram (beta)

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Diagramme d'activité

• Texte en entrée, diagramme en sortie. Décrivez le flux de haut en bas, branches et boucles incluses.
• Se lit de haut en bas. L'ordre dans le texte est l'ordre dans le diagramme.
• Facile à restructurer. Réorganiser les étapes ou ajouter une branche, c'est éditer du texte, pas redessiner.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Action simple

@startuml :Hello world; :This is defined on several **lines**; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Other simple action (defined as a list)

Simple action list separated by -

@startuml - Action 1 - Action 2 - Action 3 @enduml

Simple action list separated by *

With one level

@startuml * Action 1 * Action 2 * Action 3 @enduml

With several levels

@startuml <style> element {MinimumWidth 150} </style> * Action 1 ** Sub-Action 1.1 ** Sub-Action 1.2 *** Sub-Action 1.2.1 *** Sub-Action 1.2.2 * Action 2 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Départ/Arrêt [start, stop, end]

@startuml start :Hello world; :This is on defined on several **lines**; stop @enduml

@startuml start :Hello world; :This is on defined on several **lines**; end @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Conditionnel

• if (...) then (...) ... [else (...) ...] endif

@startuml start if (Graphviz installed?) then (yes) :process all\ndiagrams; else (no) :process only __sequence__ and __activity__ diagrams; endif stop @enduml

• if (...) is (...) then ... [else (...) ...] endif

@startuml if (color?) is (<color:red>red) then :print red; else :print not red; endif @enduml

• if (...) equals (...) then ... [else (...) ...] endif

@startuml if (counter?) equals (5) then :print 5; else :print not 5; endif @enduml

Plusieurs conditions (en mode horizontal)

@startuml start if (condition A) then (yes) :Text 1; elseif (condition B) then (yes) :Text 2; stop (no) elseif (condition C) then (yes) :Text 3; (no) elseif (condition D) then (yes) :Text 4; else (nothing) :Text else; endif stop @enduml

Plusieurs conditions (en mode vertical)

@startuml !pragma useVerticalIf on start if (condition A) then (yes) :Text 1; elseif (condition B) then (yes) :Text 2; stop elseif (condition C) then (yes) :Text 3; elseif (condition D) then (yes) :Text 4; else (nothing) :Text else; endif stop @enduml

java -jar plantuml.jar -PuseVerticalIf=on

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Switch and case [switch, case, endswitch]

@startuml start switch (test?) case ( condition A ) :Text 1; case ( condition B ) :Text 2; case ( condition C ) :Text 3; case ( condition D ) :Text 4; case ( condition E ) :Text 5; endswitch stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Arrêt après une action au sein d'une condition [kill, detach]

@startuml if (condition?) then :error; stop endif #palegreen:action; @enduml

• kill

@startuml if (condition?) then #pink:error; kill endif #palegreen:action; @enduml

• detach

@startuml if (condition?) then #pink:error; detach endif #palegreen:action; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Boucle de répétition [repeat, repeatwhile, backward]

@startuml start repeat :read data; :generate diagrams; repeat while (more data?) stop @enduml

• d'utiliser une vrai action comme cible de répétition, après le premier mot clé repeat,
• d'insérer une action dans le chemin de retour à l'aide du mot clé backward.

@startuml start repeat :foo as starting label; :read data; :generate diagrams; backward:This is backward; repeat while (more data?) stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Interruption d'une boucle [break]

@startuml start repeat :Test something; if (Something went wrong?) then (no) #palegreen:OK; break endif ->NOK; :Alert "Error with long text"; repeat while (Something went wrong with long text?) is (yes) not (no) ->//merged step//; :Alert "Success"; stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Goto and Label Processing [label, goto]

• label <label_name>
• goto <label_name>

@startuml title Point two queries to same activity\nwith `goto` start if (Test Question?) then (yes) 'space label only for alignment label sp_lab0 label sp_lab1 'real label label lab :shared; else (no) if (Second Test Question?) then (yes) label sp_lab2 goto sp_lab1 else :nonShared; endif endif :merge; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Boucle « tant que » [while]

@startuml start while (data available?) :read data; :generate diagrams; endwhile stop @enduml

@startuml while (check filesize ?) is (not empty) :read file; endwhile (empty) :close file; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Traitement parallèle [fork, fork again, end fork, end merge]

Simple fork

@startuml start fork :action 1; fork again :action 2; end fork stop @enduml

fork avec fusion finale

@startuml start fork :action 1; fork again :action 2; end merge stop @enduml

@startuml start fork :action 1; fork again :action 2; fork again :action 3; fork again :action 4; end merge stop @enduml

@startuml start fork :action 1; fork again :action 2; end end merge stop @enduml

Label sur end fork (ou UML joinspec)

@startuml start fork :action A; fork again :action B; end fork {or} stop @enduml

@startuml start fork :action A; fork again :action B; end fork {and} stop @enduml

Autre exemple

@startuml start if (multiprocessor?) then (yes) fork :Treatment 1; fork again :Treatment 2; end fork else (monoproc) :Treatment 1; :Treatment 2; endif @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Traitement fractionné

Split

@startuml start split :A; split again :B; split again :C; split again :a; :b; end split :D; end @enduml

Fractionnement de l'entrée (multidébut)

@startuml split -[hidden]-> :A; split again -[hidden]-> :B; split again -[hidden]-> :C; end split :D; @enduml

@startuml split -[hidden]-> :A; split again -[hidden]-> :a; :b; split again -[hidden]-> (Z) end split :D; @enduml

Fractionnement de la sortie (plusieurs extrémités)

@startuml start split :A; kill split again :B; detach split again :C; kill end split @enduml

@startuml start split :A; kill split again :b; :c; detach split again (Z) detach split again end split again stop end split @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Notes

@startuml start :foo1; floating note left: This is a note :foo2; note right This note is on several //lines// and can contain <b>HTML</b> ==== * Calling the method ""foo()"" is prohibited end note stop @enduml

@startuml start repeat :Enter data; :Submit; backward :Warning; note right: Note repeat while (Valid?) is (No) not (Yes) stop @enduml

@startuml start partition "**process** HelloWorld" { note This is my note ---- //Creole test// end note :Ready; :HelloWorld(i)> :Hello-Sent; } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Couleurs

@startuml start :starting progress; #HotPink:reading configuration files These files should be edited at this point!; #AAAAAA:ending of the process; @enduml

@startuml start partition #red/white testPartition { #blue\green:testActivity; } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Lignes sans pointe de flèches

@startuml skinparam ArrowHeadColor none start :Hello world; :This is on defined on several **lines**; stop @enduml

@startuml skinparam ArrowHeadColor none start repeat :Enter data; :Submit; backward :Warning; repeat while (Valid?) is (No) not (Yes) stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Flèches

@startuml :foo1; -> You can put text on arrows; if (test) then -[#blue]-> :foo2; -[#green,dashed]-> The text can also be on several lines and **very** long...; :foo3; else -[#black,dotted]-> :foo4; endif -[#gray,bold]-> :foo5; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Simple colored arrow [link]

@startuml :a; link #blue :b; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Multiple colored arrow

@startuml skinparam colorArrowSeparationSpace 1 start -[#red;#green;#orange;#blue]-> if(a?)then(yes) -[#red]-> :activity; -[#red]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#red]-> if(b?)then(yes) -[#maroon,dashed]-> else(no) -[#blue,dashed;dotted]-> :do a; -[#red]-> :do b; -[#red]-> endif -[#red;#maroon,dashed]-> endif -[#red;#maroon,dashed]-> elseif(e?)then(yes) -[#green]-> if(c?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> if(d?)then(yes) -[#maroon,dashed]-> else(no) -[#green]-> :do something; <<continuous>> -[#green]-> endif -[#green;#maroon,dashed]-> partition dummy { :some function; } -[#green;#maroon,dashed]-> endif -[#green;#maroon,dashed]-> elseif(f?)then(yes) -[#orange]-> :activity; <<continuous>> -[#orange]-> else(no) -[#blue,dashed;dotted]-> endif stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Connecteurs

@startuml start :Some activity; (A) detach (A) :Other activity; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Connecteurs en couleur

@startuml start :The connector below wishes he was blue; #blue:(B) :This next connector feels that she would be better off green; #green:(G) stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Regroupement ou partition

Groupe

@startuml start group Initialization :read config file; :init internal variable; end group group Running group :wait for user interaction; :print information; end group stop @enduml

Partition

@startuml start partition Initialization { :read config file; :init internal variable; } partition Running { :wait for user interaction; :print information; } stop @enduml

@startuml start partition #lightGreen "Input Interface" { :read config file; :init internal variable; } partition Running { :wait for user interaction; :print information; } stop @enduml

@startuml start partition "[[http://plantuml.com partition_name]]" { :read doc. on [[http://plantuml.com plantuml_website]]; :test diagram; } end @enduml

Groupe, partition, paquet, rectangle ou carte

• groupe ;
• partition ;
• paquet ;
• rectangle ;
• carte

@startuml start group Group :Activity; end group floating note: Note on Group partition Partition { :Activity; } floating note: Note on Partition package Package { :Activity; } floating note: Note on Package rectangle Rectangle { :Activity; } floating note: Note on Rectangle card Card { :Activity; } floating note: Note on Card end @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Swimlanes

@startuml |Swimlane1| start :foo1; |#AntiqueWhite|Swimlane2| :foo2; :foo3; |Swimlane1| :foo4; |Swimlane2| :foo5; stop @enduml

@startuml |#pink|Actor_For_red| start if (color?) is (red) then #pink:**action red**; :foo1; else (not red) |#lightgray|Actor_For_no_red| #lightgray:**action not red**; :foo2; endif |Next_Actor| #lightblue:foo3; :foo4; |Final_Actor| #palegreen:foo5; stop @enduml

• |[#<color>|]<swimlane_alias>| <swimlane_title>

@startuml |#palegreen|f| fisherman |c| cook |#gold|e| eater |f| start :go fish; |c| :fry fish; |e| :eat fish; stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Détacher ou arrêter [detach, kill]

• detach

@startuml :start; fork :foo1; :foo2; fork again :foo3; detach endfork if (foo4) then :foo5; detach endif :foo6; detach :foo7; stop @enduml

• kill

@startuml :start; fork :foo1; :foo2; fork again :foo3; kill endfork if (foo4) then :foo5; kill endif :foo6; kill :foo7; stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Emoji as action (with icon stereotype)

@startuml while (<:cloud_with_rain:>) :<:umbrella:>; <<icon>> endwhile -<<icon>><:closed_umbrella:> @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

SDL (Specification and Description Language)

• |
• <
• >
• /
• \\
• ]
• }

@startuml :Ready; :next(o)| :Receiving; split :nak(i)< :ack(o)> split again :ack(i)< :next(o) on several line| :i := i + 1] :ack(o)> split again :err(i)< :nak(o)> split again :foo/ split again :bar\\ split again :i > 5} stop end split :finish; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

UML (Unified Modeling Language) Shape (with UML stereotype)

Table of UML Shape Name

UML Shape Example using Stereotype

@startuml :action; :object; <<object>> :ObjectNode typed by signal; <<objectSignal>> :AcceptEventAction without TimeEvent trigger; <<acceptEvent>> :SendSignalAction; <<sendSignal>> :SendObjectAction with signal type; <<sendSignal>> :Trigger; <<trigger>> :\t\t\t\t\t\tAcceptEventAction \t\t\t\t\t\twith TimeEvent trigger; <<timeEvent>> :an action; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Exemple complet

@startuml start :ClickServlet.handleRequest(); :new page; if (Page.onSecurityCheck) then (true) :Page.onInit(); if (isForward?) then (no) :Process controls; if (continue processing?) then (no) stop endif if (isPost?) then (yes) :Page.onPost(); else (no) :Page.onGet(); endif :Page.onRender(); endif else (false) endif if (do redirect?) then (yes) :redirect process; else if (do forward?) then (yes) :Forward request; else (no) :Render page template; endif endif stop @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Style de condition

Style intérieur (par défaut)

@startuml skinparam conditionStyle inside start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml

@startuml start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml

Style diamant

@startuml skinparam conditionStyle diamond start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml

Style InsideDiamond (ou Foo1)

@startuml skinparam conditionStyle InsideDiamond start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml

@startuml skinparam conditionStyle foo1 start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Style de fin de condition

Style diamant (par défaut)

• Avec une branche

@startuml skinparam ConditionEndStyle diamond :A; if (decision) then (yes) :B1; else (no) endif :C; @enduml

• Avec deux branches (B1, B2)

@startuml skinparam ConditionEndStyle diamond :A; if (decision) then (yes) :B1; else (no) :B2; endif :C; @enduml @enduml

Style ligne horizontale (hline)

• Avec une branche

@startuml skinparam ConditionEndStyle hline :A; if (decision) then (yes) :B1; else (no) endif :C; @enduml

• Avec deux branches (B1, B2)

@startuml skinparam ConditionEndStyle hline :A; if (decision) then (yes) :B1; else (no) :B2; endif :C; @enduml @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Avec le style (global)

Sans style (par défaut)

@startuml start :init; -> test of color; if (color?) is (<color:red>red) then :print red; else :print not red; note right: no color endif partition End { :end; } -> this is the end; end @enduml

Avec style

@startuml <style> activityDiagram { BackgroundColor #33668E BorderColor #33668E FontColor #888 FontName arial diamond { BackgroundColor #ccf LineColor #00FF00 FontColor green FontName arial FontSize 15 } arrow { FontColor gold FontName arial FontSize 15 } partition { LineColor red FontColor green RoundCorner 10 BackgroundColor PeachPuff } note { FontColor Blue LineColor Navy BackgroundColor #ccf } } document { BackgroundColor transparent } </style> start :init; -> test of color; if (color?) is (<color:red>red) then :print red; else :print not red; note right: no color endif partition End { :end; } -> this is the end; end @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Creole on Activity

@startuml :Creole: wave: ~~wave~~ bold: **bold** italics: //italics// monospaced: ""monospaced"" stricken-out: --stricken-out-- underlined: __underlined__ not-underlined: ~__not underlined__ wave-underlined: ~~wave-underlined~~; :HTML Creole: bold: <b>bold italics: <i>italics monospaced: <font:monospaced>monospaced stroked: <s>stroked underlined: <u>underlined waved: <w>waved green-stroked: <s:green>stroked red-underlined: <u:red>underlined blue-waved: <w:#0000FF>waved Blue: <color:blue>Blue Orange: <back:orange>Orange background big: <size:20>big; :Graphic: OpenIconic: account-login <&account-login> Unicode: This is <U+221E> long Emoji: <:calendar:> Calendar Image: <img:https://plantuml.com/logo3.png>; @enduml