Graphviz macro - Cloud

Removal notice

Please note that the URL user and URL user password macro parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

Description
The Graphviz macro creates general graphs - either directed or undirected using the Graphviz language. This language is extremely versatile and powerful, but you can start with a really simple example as shown below, and then gradually improve your knowledge and create more advanced diagrams easily.

Graphviz resources
Graphviz is a powerful way of describing diagrams of any kind, using just text. Graphviz provides automatic layout of diagrams based on the text. Have a look at the following Graphviz resources.
Graphviz home
Gallery Of Example Diagrams
Online Documentation
Getting started tutorial - Jodie Miners has provided this nice tutorial
Color names

Parameters
Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.
The following parameters are available with all Graphviz macros:
Macro Editor Label
Default
Description
Macro Parameter
Output type svg
Specifies the output type to be generated by Graphviz.
png
svg
jpg
gif
output
Profile
Specifies the profile the macro uses to read data from an external application such as GitLab or GitHub.
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 administrator guide to understand more about profiles.

This parameter is not available in Graph from table and Space graph macros.

Location of Graphviz source
Specifies the source from where the macro reads the data.
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.

Files and templates are not applicable for Confluence Cloud. Refer to the Migration guide 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
Show Graphviz markup code False Shows 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. showCode
Attachment name
The name of the attachment to use. Useful when the Graphviz image must be uploaded as a new attachment or to update an existing attachment. Use of attachments is optional but can be useful for linking from other places.
Examples:
graphviz.png — the image is saved as an attachment to the current page.
page^graphviz.png — the image is saved as an attachment to the page name provided.
space:page^graphviz.png — the image is saved as an attachment to the page name provided in the space indicated.
attachment
Attachment version new
Specifies how the generated graph is persisted as an attachment.
New — creates a new version of the attachment.
Replace — replaces all previous versions of the attachment. To replace an existing attachment, the user must be authorized to remove attachments for the page specified.
Keep — only saves a new attachment if there is no existing attachment. An existing attachment will not be changed or updated.
attachmentVersion
Attachment comment
Specifies the comment on the attachment that is created or updated.
attachmentComment
Attachment versions to keep
Limits the number of attachment versions of a file that is attached to a page. If the maximum number of attachments exceeds the limit, then the oldest version is deleted.

This parameter is only applicable if you select New from the drop-down list under Attachment version, in the macro editor.
attachmentLimit
Thumbnail False
Used when an attachment is specified, and output is png, jpg, or gif. Renders graph as a thumbnail with default size 128x128px.

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.
thumbnail
Render wiki markup macros in body False
Set to true to render wiki markup macros found in the body before processing as Graphviz markup.

Only the following wiki markup macros are supported for processing as Graphviz markup:
noformat
code
In other words, the output of any other wiki markup macro (that is not available on Cloud), is not a valid input to Graphviz macros. Though you can insert such macros in the Graphviz macro body, you are likely to encounter a rendering error in the published page.
This parameter is not available in Graph from table and Space graph macros.
macros
Layout dot
Specifies which default layout algorithm to use.
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
URL to 'macro' file
(macro ~ Graphviz/ Diagraph/ Graph)

Specifies the URL link to the Graphviz file. Administrators may restrict use.

The URLs are restricted to the whitelisted URLs.
This parameter is not available in Graph from table and Space graph macros.
URL
URL user (Removed)
Specifies the user name for URL access via basic authentication.
Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.
user
URL user password (Removed)
Specifies the user password for URL access via basic authentication.
Removal notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.
password
URL connection timeout
Used to increase the wait time for URL access on slower connections. timeout
File encoding
Allows the user to specify the encoding if it is different from the Confluence default (like Windows-1252, UTF-8, MacRoman).
encoding

It is recommended to use the right click > Open Link in New Tab option to open any hyperlinks in nodes.
Example
This is a very basic example of what you can achieve easily. For more advanced layouts and formatting, please refer to the Graphviz resources.
Macro Call
Macro Output
{graphviz} digraph { A -> B A -> C C -> D } {graphviz}

Macro Editor Label	Default	Description	Macro Parameter
Output type	svg	Specifies the output type to be generated by Graphviz. png svg jpg gif	output
Profile		Specifies the profile the macro uses to read data from an external application such as GitLab or GitHub. 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 administrator guide to understand more about profiles. This parameter is not available in Graph from table and Space graph macros.
Location of Graphviz source		Specifies the source from where the macro reads the data. 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. Files and templates are not applicable for Confluence Cloud. Refer to the Migration guide 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
Show Graphviz markup code	False	Shows 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.	showCode
Attachment name		The name of the attachment to use. Useful when the Graphviz image must be uploaded as a new attachment or to update an existing attachment. Use of attachments is optional but can be useful for linking from other places. Examples: graphviz.png — the image is saved as an attachment to the current page. page^graphviz.png — the image is saved as an attachment to the page name provided. space:page^graphviz.png — the image is saved as an attachment to the page name provided in the space indicated.	attachment
Attachment version	new	Specifies how the generated graph is persisted as an attachment. New — creates a new version of the attachment. Replace — replaces all previous versions of the attachment. To replace an existing attachment, the user must be authorized to remove attachments for the page specified. Keep — only saves a new attachment if there is no existing attachment. An existing attachment will not be changed or updated.	attachmentVersion
Attachment comment		Specifies the comment on the attachment that is created or updated.	attachmentComment
Attachment versions to keep		Limits the number of attachment versions of a file that is attached to a page. If the maximum number of attachments exceeds the limit, then the oldest version is deleted. This parameter is only applicable if you select New from the drop-down list under Attachment version, in the macro editor.	attachmentLimit
Thumbnail	False	Used when an attachment is specified, and output is png, jpg, or gif. Renders graph as a thumbnail with default size 128x128px. 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.	thumbnail
Render wiki markup macros in body	False	Set to true to render wiki markup macros found in the body before processing as Graphviz markup. Only the following wiki markup macros are supported for processing as Graphviz markup: noformat code In other words, the output of any other wiki markup macro (that is not available on Cloud), is not a valid input to Graphviz macros. Though you can insert such macros in the Graphviz macro body, you are likely to encounter a rendering error in the published page. This parameter is not available in Graph from table and Space graph macros.	macros
Layout	dot	Specifies which default layout algorithm to use. 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
URL to 'macro' file (macro ~ Graphviz/ Diagraph/ Graph)		Specifies the URL link to the Graphviz file. Administrators may restrict use. The URLs are restricted to the whitelisted URLs. This parameter is not available in Graph from table and Space graph macros.	URL
URL user (Removed)		Specifies the user name for URL access via basic authentication. Removal notice Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.	user
URL user password (Removed)		Specifies the user password for URL access via basic authentication. Removal notice Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.	password
URL connection timeout		Used to increase the wait time for URL access on slower connections.	timeout
File encoding		Allows the user to specify the encoding if it is different from the Confluence default (like Windows-1252, UTF-8, MacRoman).	encoding