Migrate from PlantUML for Confluence (Avono) to Capable Diagrams
To migrate from Avono's PlantUML for Confluence, a Confluence administrator opens the Migration tab in Capable, selects PlantUML for Confluence (Avono) and its macros, runs Perform verification, then Start migration. PlantUML and flowchart macros become Capable diagrams; Link Graph and Space Graph macros become Capable Link graph and Space graph macros.
#Before you start
You need | Why |
|---|---|
Confluence administrator rights | Only administrators can open the Migration tab. |
A pilot space | A small first run shows you the real failure rate in minutes. |
The browser tab left open | The migration runs in your browser and stops if you close the tab. |
#Steps
In Confluence administration, open the app's settings page (Capable, or Capable Diagrams for the standalone app) and select the Migration tab.
Read Introduction and tick the confirmations, then go to Options. Leave Skip errors on. Turn on Keep diagram version history under Advanced options if you want PlantUML diagrams replayed version by version. It is slower.
In Select apps, choose PlantUML for Confluence (Avono).
In Select macros, choose PlantUML & Flowchart, Link Graph and Space Graph as needed, and narrow the pages to your pilot space.
On Run, select Perform verification. It reads the pages and writes nothing. Read the results.
Select Start migration. When it finishes, select Download log and keep the file.
#What converts
Macro | Becomes | Worth knowing |
|---|---|---|
PlantUML & Flowchart | A Capable diagram holding the PlantUML, GraphViz or ditaa source | The title is kept. If the macro body is empty, the source is recovered from an earlier page version. JCCKit, Math, LaTeX, ASCII and Creole diagrams are reported as unsupported and left unchanged. |
Link Graph | Link graph (Capable) | Space, page, outgoing link depth, direction, node limit, labels and height carry over. Outgoing depth is capped at two levels, and incoming link levels are reset to zero because Confluence Cloud cannot resolve them. |
Space Graph | Space graph (Capable) | Space, page, depth, direction, node limit and height carry over. Depth is capped at three levels. |
An inline Link Graph or Space Graph becomes a block macro, so the paragraph around it is split.
A PlantUML macro wrapping a GitHub file becomes a Capable Git embed, but only in Capable for Confluence and only for GitHub. Otherwise it is reported as unsupported.
In the Zero Egress edition of Capable Diagrams, only PlantUML & Flowchart is offered.
#What happens next
Each page the run changes gets a new version labelled "Migrated by Capable", so any page can be put back from its history.
Re-running is safe. Run again for more spaces, or for pages that failed once you have fixed the cause.
To undo a whole run, open Repair on the Migration tab and use Roll back pages with the log you downloaded. See Roll back a Confluence macro migration.
#If it does not work
No Migration tab: you are not a Confluence administrator, or you are in the wrong app. See I cannot find the Migration tab.
Pages you cannot edit are skipped and reported as permission failures. Use Admin Key (experimental) under Advanced options lets an administrator migrate them.
#Related
PlantUML for Confluence (Avono/DC)
Full migration notes for every Avono macro.
Migrate from PlantUML for Confluence (Data Center)
Moving from Data Center first.
PlantUML
Where migrated diagrams live.
Page and space graphs
The Capable graph macros.
Test a Confluence migration with a dry run
Verify before you write anything.
Roll back a Confluence macro migration
Undo a run from its log.
PlantUML stays PlantUML. Only the macro changes.
