PlantUMLLanguage specificationActivity Diagram (beta)

       

Activity Diagram (beta) Edit in DokuwikiEdit in AsciidocEdit in Markdown 기존의 activity diagram 문법 은 몇몇 제약과 단점이 있다.(예를 들면, 유지보수가 어렵다.) 그래서 완전 새로운 문법과 구현이 베타버전으로 고안되었고, 우리는 더 나은 포맷과 문법으로 정의할 수 있었다. 이 새로운 구현의 또 다른 장점은 (시퀀스 다이어그램과 같이) Graphviz를 설치할 필요 없이 수행된다는 것이다. 새로운 구문이 이전 구문을 대체할 것이다. 그러나 호환성을 보장하기 위해 이전 구문이 여전히 인식될 것이다. 새로운 구문으로 이전을 권장한다. Simple action Edit in DokuwikiEdit in AsciidocEdit in Markdown Activities label starts with : and ends with ;. Text formatting can be done using creole wiki syntax. They are implicitly linked in their definition order. 🎉 Copied! @startuml :Hello world; :This is defined on several **lines**; @enduml Start/Stop/End Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use start and stop keywords to denote the beginning and the end of a diagram. 🎉 Copied! @startuml start :Hello world; :This is defined on several **lines**; stop @enduml You can also use the end keyword. 🎉 Copied! @startuml start :Hello world; :This is defined on several **lines**; end @enduml Conditional Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use if, then and else keywords to put tests if your diagram. Labels can be provided using parentheses. 🎉 Copied! @startuml start if (Graphviz installed?) then (yes) :process all\ndiagrams; else (no) :process only __sequence__ and __activity__ diagrams; endif stop @enduml You can use the elseif keyword to have several tests : 🎉 Copied! @startuml 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 *[Refs. [QA-3931](https:forum.plantuml.net/3931/please-provide-elseif-structure-vertically-activity-diagrams), [issue-582](https:github.com/plantuml/plantuml/issues/582)]* WARNING  This translation need to be updated.  WARNING Switch and case [switch, case, endswitch] Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use switch, case and endswitch keywords to put switch in your diagram. Labels can be provided using parentheses. 🎉 Copied! @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 Conditional with stop on an action [kill, detach] Edit in DokuwikiEdit in AsciidocEdit in Markdown You can stop action on a if loop. 🎉 Copied! @startuml if (condition?) then :error; stop endif #palegreen:action; @enduml But if you want to stop at the precise action, you can use the kill or detach keyword: kill 🎉 Copied! @startuml if (condition?) then #pink:error; kill endif #palegreen:action; @enduml [Ref. QA-265] detach 🎉 Copied! @startuml if (condition?) then #pink:error; detach endif #palegreen:action; @enduml Repeat loop Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use repeat and repeatwhile keywords to have repeat loops. 🎉 Copied! @startuml start repeat :read data; :generate diagrams; repeat while (more data?) is (yes) ->no; stop @enduml It is also possible to use a full action as repeat target and insert an action in the return path using the backward keyword. 🎉 Copied! @startuml start repeat :foo as starting label; :read data; :generate diagrams; backward:This is backward; repeat while (more data?) stop @enduml Break on a repeat loop [break] Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use the break keyword after an action on a loop. 🎉 Copied! @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 [Ref. QA-6105] Goto and Label Processing [label, goto] Edit in DokuwikiEdit in AsciidocEdit in Markdown ⚠ It is currently only experimental 🚧 You can use label and goto keywords to denote goto processing, with: label <label_name> goto <label_name> 🎉 Copied! @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 lab else :nonShared; endif endif :merge; @enduml [Ref. QA-15026, QA-12526 and initially QA-1626] While loop Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use while and endwhile keywords to have repeat loops. 🎉 Copied! @startuml start while (data available?) :read data; :generate diagrams; endwhile stop @enduml It is possible to provide a label after the endwhile keyword, or using the is keyword. 🎉 Copied! @startuml while (check filesize ?) is (not empty) :read file; endwhile (empty) :close file; @enduml If you are using detach to form an infinite while loop, then you will want to also hide the partial arrow that results using -[hidden]-> 🎉 Copied! @startuml :Step 1; if (condition1) then while (loop forever) :Step 2; endwhile -[hidden]-> detach else :end normally; stop endif @enduml Parallel processing [fork, fork again, end fork, end merge] Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use fork, fork again and end fork or end merge keywords to denote parallel processing. Simple fork 🎉 Copied! @startuml start fork :action 1; fork again :action 2; end fork stop @enduml fork with end merge 🎉 Copied! @startuml start fork :action 1; fork again :action 2; end merge stop @enduml [Ref. QA-5320] 🎉 Copied! @startuml start fork :action 1; fork again :action 2; fork again :action 3; fork again :action 4; end merge stop @enduml 🎉 Copied! @startuml start fork :action 1; fork again :action 2; end end merge stop @enduml [Ref. QA-13731] Label on end fork (or UML joinspec): 🎉 Copied! @startuml start fork :action A; fork again :action B; end fork {or} stop @enduml 🎉 Copied! @startuml start fork :action A; fork again :action B; end fork {and} stop @enduml [Ref. QA-5346] Other example 🎉 Copied! @startuml start if (multiprocessor?) then (yes) fork :Treatment 1; fork again :Treatment 2; end fork else (monoproc) :Treatment 1; :Treatment 2; endif @enduml Split processing Edit in DokuwikiEdit in AsciidocEdit in Markdown Split You can use split, split again and end split keywords to denote split processing. 🎉 Copied! @startuml start split :A; split again :B; split again :C; split again :a; :b; end split :D; end @enduml Input split (multi-start) You can use hidden arrows to make an input split (multi-start): 🎉 Copied! @startuml split -[hidden]-> :A; split again -[hidden]-> :B; split again -[hidden]-> :C; end split :D; @enduml 🎉 Copied! @startuml split -[hidden]-> :A; split again -[hidden]-> :a; :b; split again -[hidden]-> (Z) end split :D; @enduml [Ref. QA-8662] Output split (multi-end) You can use kill or detach to make an output split (multi-end): 🎉 Copied! @startuml start split :A; kill split again :B; detach split again :C; kill end split @enduml 🎉 Copied! @startuml start split :A; kill split again :b; :c; detach split again (Z) detach split again end split again stop end split @enduml Notes Edit in DokuwikiEdit in AsciidocEdit in Markdown Text formatting can be done using creole wiki syntax. A note can be floating, using floating keyword. 🎉 Copied! @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 You can add note on backward activity: 🎉 Copied! @startuml start repeat :Enter data; :Submit; backward :Warning; note right: Note repeat while (Valid?) is (No) not (Yes) stop @enduml [Ref. QA-11788] You can add note on partition activity: 🎉 Copied! @startuml start partition "**process** HelloWorld" { note This is my note ---- //Creole test// end note :Ready; :HelloWorld(i)> :Hello-Sent; } @enduml [Ref. QA-2398] Colors Edit in DokuwikiEdit in AsciidocEdit in Markdown You can specify a color for some activities. 🎉 Copied! @startuml start :starting progress; #HotPink:reading configuration files These files should be edited at this point!; #AAAAAA:ending of the process; @enduml You can also use gradient color. 🎉 Copied! @startuml start partition #red/white testPartition { #blue\green:testActivity; } @enduml [Ref. QA-4906] Lines without arrows Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use skinparam ArrowHeadColor none in order to connect activities using lines only, without arrows. 🎉 Copied! @startuml skinparam ArrowHeadColor none start :Hello world; :This is on defined on several **lines**; stop @enduml 🎉 Copied! @startuml skinparam ArrowHeadColor none start repeat :Enter data; :Submit; backward :Warning; repeat while (Valid?) is (No) not (Yes) stop @enduml Arrows Edit in DokuwikiEdit in AsciidocEdit in Markdown Using the -> notation, you can add texts to arrow, and change their color. It's also possible to have dotted, dashed, bold or hidden arrows. 🎉 Copied! @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 Connector Edit in DokuwikiEdit in AsciidocEdit in Markdown You can use parentheses to denote connector. 🎉 Copied! @startuml start :Some activity; (A) detach (A) :Other activity; @enduml Color on connector Edit in DokuwikiEdit in AsciidocEdit in Markdown You can add color on connector. 🎉 Copied! @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 [Ref. QA-10077] Grouping or partition Edit in DokuwikiEdit in AsciidocEdit in Markdown Group You can group activity together by defining group: 🎉 Copied! @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 You can group activity together by defining partition: 🎉 Copied! @startuml start partition Initialization { :read config file; :init internal variable; } partition Running { :wait for user interaction; :print information; } stop @enduml It's also possible to change partition color: 🎉 Copied! @startuml start partition #lightGreen "Input Interface" { :read config file; :init internal variable; } partition Running { :wait for user interaction; :print information; } stop @enduml [Ref. QA-2793] It's also possible to add link to partition: 🎉 Copied! @startuml start partition "[[http://plantuml.com partition_name]]" { :read doc. on [[http://plantuml.com plantuml_website]]; :test diagram; } end @enduml [Ref. QA-542] Group, Partition, Package, Rectangle or Card You can group activity together by defining: group; partition; package; rectangle; card. 🎉 Copied! @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 Swimlanes Edit in DokuwikiEdit in AsciidocEdit in Markdown Using pipe |, you can define swimlanes. It's also possible to change swimlanes color. 🎉 Copied! @startuml |Swimlane1| start :foo1; |#AntiqueWhite|Swimlane2| :foo2; :foo3; |Swimlane1| :foo4; |Swimlane2| :foo5; stop @enduml You can add if conditional or repeat or while loop within swimlanes. 🎉 Copied! @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 You can also use alias with swimlanes, with this syntax: |[#<color>|]<swimlane_alias>| <swimlane_title> 🎉 Copied! @startuml |#palegreen|f| fisherman |c| cook |#gold|e| eater |f| start :go fish; |c| :fry fish; |e| :eat fish; stop @enduml [Ref. QA-2681] Detach or kill [detach, kill] Edit in DokuwikiEdit in AsciidocEdit in Markdown It's possible to remove an arrow using the detach or kill keyword: detach 🎉 Copied! @startuml :start; fork :foo1; :foo2; fork again :foo3; detach endfork if (foo4) then :foo5; detach endif :foo6; detach :foo7; stop @enduml kill 🎉 Copied! @startuml :start; fork :foo1; :foo2; fork again :foo3; kill endfork if (foo4) then :foo5; kill endif :foo6; kill :foo7; stop @enduml SDL (Specification and Description Language) Edit in DokuwikiEdit in AsciidocEdit in Markdown By changing the final ; separator, you can set different rendering for the activity: | < > / \\ ] } 🎉 Copied! @startuml :Ready; :next(o)| :Receiving; split :nak(i)< :ack(o)> split again :ack(i)< :next(o) on several lines| :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 Complete example Edit in DokuwikiEdit in AsciidocEdit in Markdown 🎉 Copied! @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 Condition Style Edit in DokuwikiEdit in AsciidocEdit in Markdown Inside style (by default) 🎉 Copied! @startuml skinparam conditionStyle inside start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml 🎉 Copied! @startuml start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml Diamond style 🎉 Copied! @startuml skinparam conditionStyle diamond start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml InsideDiamond (or Foo1) style 🎉 Copied! @startuml skinparam conditionStyle InsideDiamond start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml 🎉 Copied! @startuml skinparam conditionStyle foo1 start repeat :act1; :act2; repeatwhile (<b>end) :act3; @enduml [Ref. QA-1290 and #400] Condition End Style Edit in DokuwikiEdit in AsciidocEdit in Markdown Diamond style (by default) With one branch 🎉 Copied! @startuml skinparam ConditionEndStyle diamond :A; if (decision) then (yes) :B1; else (no) endif :C; @enduml With two branches (B1, B2) 🎉 Copied! @startuml skinparam ConditionEndStyle diamond :A; if (decision) then (yes) :B1; else (no) :B2; endif :C; @enduml @enduml Horizontal line (hline) style With one branch 🎉 Copied! @startuml skinparam ConditionEndStyle hline :A; if (decision) then (yes) :B1; else (no) endif :C; @enduml With two branches (B1, B2) 🎉 Copied! @startuml skinparam ConditionEndStyle hline :A; if (decision) then (yes) :B1; else (no) :B2; endif :C; @enduml @enduml [Ref. QA-4015] Using (global) style Edit in DokuwikiEdit in AsciidocEdit in Markdown Without style (by default) 🎉 Copied! @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 With style You can use style to change rendering of elements. 🎉 Copied! @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

Simple action Start/Stop/End Conditional Switch and case [switch, case, endswitch] Conditional with stop on an action [kill, detach] Repeat loop Break on a repeat loop [break] Goto and Label Processing [label, goto] While loop Parallel processing [fork, fork again, end fork, end merge] Split processing Notes Colors Lines without arrows Arrows Connector Color on connector Grouping or partition Swimlanes Detach or kill [detach, kill] SDL (Specification and Description Language) Complete example Condition Style Condition End Style Using (global) style