Revelation Documentation Email support
Diagram types

Sequence diagrams

Follow a request through the systems involved and see which message happens next.

Create a request and reply

  1. Create a Sequence Diagram model and select the Sequence layout.
  2. Add participants for Student, Portal and Records using Actor, Component and Database types.
  3. Connect Student to Portal with a synchronous call, then Portal to Records with another call.
  4. Add returns from Records to Portal, then Portal to Student. Name each message with its purpose.
  5. Save and reopen the model to check message order.

Order matters

Interaction array/insertion order is message order. Sorting the Interactions table is only a table display change. For a substantial message reorder, work carefully with the JSON order or request a bounded Rovo update, preserving IDs and fragment nesting.

Fragments

The sequence palette offers fragment controls. A fragment opener and an End marker bracket a sequence of interactions; nested fragments close from the inside out. Loop, Optional, Alternative, Break, Parallel and Reference types are supported as labelled enclosures.

Alternative and Parallel fragments do not have separate else/operand compartments. Use clear guarded labels and, where appropriate, separate Optional fragments rather than implying a fully partitioned UML alt/par structure.

Participant lifecycle

Choose synchronous/asynchronous calls and returns deliberately. Create and Destroy messages indicate participant lifecycle changes. Found/Lost messages use an External participant at the unknown end; do not use External as an ordinary participant for other messages.

Fragments have no From/To endpoints. Their labels and position in the interaction array determine the enclosure. Review activation and lifecycle rendering after an import.

Download the sequence request example (JSON)

Sequence diagrams example rendered in Revelation
Revelation: the downloadable example rendered by Revelation. Select the image to view it at full size.

Try this with Rovo in Confluence

Choose the matching Revelation agent. Supply the destination page and review the result before sharing. Follow the Rovo guide to attach the created model to a macro.

Create a sequence diagram with Student, Portal and Records. Student calls Portal, Portal calls Records, Records returns details, then Portal returns the result to Student. Preserve that message order.

Supported element types

NameModel token
Actor (Sequence)SEQ_ACTOR
BoundarySEQ_BOUNDARY
ControlSEQ_CONTROL
Entity (Sequence)SEQ_ENTITY
Database (Sequence)SEQ_DATABASE
Component (Sequence)SEQ_COMPONENT
ExternalSEQ_EXTERNAL
GroupGROUP

Supported relationship types

NameModel token
Synchronous CallSEQ_SYNC_CALL
Asynchronous CallSEQ_ASYNC_CALL
Return MessageSEQ_RETURN
Create MessageSEQ_CREATE
Destroy MessageSEQ_DESTROY
Found MessageSEQ_FOUND
Lost MessageSEQ_LOST
Fragment: AlternativeSEQ_FRG_ALT
Fragment: OptionalSEQ_FRG_OPT
Fragment: LoopSEQ_FRG_LOOP
Fragment: BreakSEQ_FRG_BREAK
Fragment: ParallelSEQ_FRG_PAR
Fragment: ReferenceSEQ_FRG_REF
End FragmentSEQ_FRG_END