Revelation for Confluence Documentation Email support
Start here

Your first diagram in Revelation for Confluence

Give your team a diagram they can open, explore and discuss without leaving the Confluence page.

Let’s give a project page a simple picture of a student service. You will add a student, a self-service portal and a records store, connect them, and save the model for your colleagues to explore.

Student uses Student self-service, which reads and updates Student records

Scroll sideways to see the full diagram.

Your first model: follow the student’s request from the portal to the records it uses. This diagram is available in both apps. Download the example or select the diagram to view it at full size.

Before you start: Revelation for Confluence is installed and you can edit the Confluence page. If you cannot find the macro, ask your administrator to follow installation and access.

Add the diagram macro

  1. Edit your Confluence page and insert Revelation diagram using the macro search.
  2. A new macro starts with its own empty diagram. Leave it as a new diagram; configuration is only needed if you want to select an existing attachment.
  3. Publish or update the page, then use the empty diagram's edit/start button to open the full-screen Revelation for Confluence editor.

Create a small model

  1. In the Revelation for Confluence editor, choose Menu → New model…. Confirm that you want to replace the current editing session if prompted.
  2. Use Title Student service, Model type C4 Architecture, then Create.
  3. Drag + Element onto the canvas three times, choosing the type in the picker each time. Set the names/types to Student / Actor, Student portal / System and Student records / DataStore.
  4. Select Student and drag its connection handle to Student portal. Select the arrow and name it Uses. Connect Student portal to Student records and name that arrow Reads and updates.
  5. Rename Student portal to Student self-service and move it slightly.

Save and reopen

  1. Select Save to page. Resolve any view-save prompt so the intended arrangement is kept, then wait for save confirmation.
  2. Close the editor. The diagram macro reloads the saved attachment.
  3. Open Edit again and confirm the renamed element is present. If you also changed the Confluence page's macro placement or configuration, publish/update those page changes.

You now have a shared diagram. Your colleagues can read it on the page and use Explore to investigate it. Save to page is what keeps your edits; remember to use it before closing the editor.

Start from a file instead

Download the student service example (JSON)

Download this example, then use Menu → Open local model… inside the Revelation for Confluence editor. Opening the file replaces the editing session. It changes the attached model only when you choose Save to page.

Next steps