---
title: "PlantUML macro - Cloud"
canonical: "https://support.appfire.com/space/GVIZ/3556540420/PlantUML%20macro%20-%20Cloud"
format: markdown
---
## Description

The *PlantUML macro* creates diagrams using the PlantUML language. You can start with a basic example and build more advanced diagrams as needed.

## PlantUML resources

Refer to the [PlantUML website](https://plantuml.com/) to learn more about the language and access guides and examples.

## Parameters

| **Macro Editor Label** | **Example** | **Description** | **Macro Parameter** |
| --- | --- | --- | --- |
| Data Source | ![Graphviz Diagrams for Confluence PlantUML Embed Code](media://2c3af2b5-c1d0-4139-aeb0-92d4150b7e72) | Specifies the source from where the macro reads the data.<br>- *blank* - The body is used.
- *^attachment* - Data is read from an attachment to the current page. Input the value in the format ^*Filename.extension.*
- *page^attachment* - Data is read from an attachment to the page name provided.
- *space:page^attachment* - Data is read from an attachment to the page name provided in the space indicated.
- *global page template name* - Data is read from a global page template.
- *space:page template name* - Data is read from a space template.<br>> ⚠️ - Files and templates are not applicable for Confluence Cloud. Refer to the <u>[Migration guide](https://bobswift.atlassian.net/wiki/x/NYOkOw)</u> for more details.
> ⚠️ - Graphviz recognizes the commands only when you nest the commands under *noformat*, *code*, or *code-pro* macros, for the sources mentioned below:
> ⚠️   - *global page template name *
> ⚠️   - *space:page template name* | script |
| URL | ![Graphviz Diagrams for Confluence PlantUML Macro URL](media://8ec22f94-3d53-4e51-8f8c-4df8d858d455) | Specifies the URL link to the Graphviz file. Administrators may restrict use.<br>> ⚠️ - The URLs are restricted to the whitelisted URLs.
> ⚠️ - This parameter is not available in *Graph from table* and *Space graph* macros. |  |
| Profile | ![Graphviz Diagrams for Confluence PlantUML Macro Profile](media://9b982ce0-3761-4bb9-932a-8aec5203dba1) | Specifies the profile the macro uses to read data from an external application such as GitLab or GitHub.<br>Profiles refer to common parameters that administrators create and configure to access data from external sources. Contact your administrator to know more about the profiles that are configured in your instance. Refer to the <u>[administrator guide](https://appfire.atlassian.net/wiki/spaces/GVIZ/pages/70224052/Configure+for+cloud#gviz_config_profiles)</u> to understand more about profiles.<br>> ⚠️ This parameter is not available in *Graph from table* and *Space graph* macros. |  |
| Attachment | ![Graphviz Diagrams for Confluence - PlantUML Macro - Attachment](media://0ed252b7-cc0e-473d-80c6-116feedb666f) | Data is read from an attachment to the page name provided in the space indicated. |  |
| Layout | ![Graphviz Diagrams for Confluence - PlantUML Macro - Layout](media://220d78f3-e44f-4ba8-bee5-03ce8ca88e9b) | Specifies which default layout algorithm to use.<br>- *dot*− filter for drawing directed graphs
- *neato* − filter for drawing undirected graphs
- *twopi*− filter for radial layouts of graphs
- *circo*− filter for a circular layout of graphs
- *fdp*− filter for drawing undirected graphs | layout |
| Settings | ![Graphviz Diagrams for Confluence - PlantUML Macro - Settings](media://5bc59b87-9f6e-47fa-8292-e64946f313c7) | **Output Type** - specify the output type generated by Graphviz.<br>- png
- svg
- jpg
- gif<br>**Show Graphviz markup code** - Enter a checkmark to display the Graphviz markup code below the generated graph. Useful for fixing syntax errors or to see the markup that is generated by macro processing or macros like the Space graph macro.<br>**Thumbnail** - Used when an attachment is specified, and output is *png*, *jpg*, or *gif*. Renders graph as a thumbnail with default size 128x128px.<br>> ⚠️ - In some cases, the image and the thumbnail generated are of the same size. This is because the image is too small and fits the preview screen perfectly.
> ⚠️ - This parameter is not applicable for *Graph* macro. | output<br>showCode<br>thumbnail |

## Example

Here is a basic example of the PlantUML macro. For more advanced layouts and formatting, refer to the [PlantUML website](https://plantuml.com/).

| **Macro call** | **Macro output** |
| --- | --- |
| ```
{plantuml}
@startuml
!$ab = "foo1"
!$cd = "foo2"
!$ef = $ab + $cd

Alice -> Bob : $ab
Alice -> Bob : $cd
Alice -> Bob : $ef
@enduml
{plantuml}
``` | ![image-20260825-142117.png](media://c960d392-cc5e-4888-9bc7-4057a3577ba6) |