---
title: "Common parameters"
canonical: "https://support.appfire.com/space/GVIZ/70222334/Common%20parameters"
format: markdown
---
> Macro (aura-html)

<span style="color: #000000">The following parameters are available with all Graphviz macros:</span>

| <span style="color: #000000">**Macro editor label**</span> | <span style="color: #000000">**Default**</span> | <span style="color: #000000">**Description**</span> | <span style="color: #000000">**Macro parameter**</span> |
| --- | --- | --- | --- |
| <span style="color: #000000">Template</span> |  | <span style="color: #000000">Enables users to pick a pre-configured template and make simple changes as per their requirement. Since 3.2.</span><br>> ⚠️ - <span style="color: #000000">These templates are available in the macro editor only when the macro body is empty. If the macro body is not empty, the user are unable to see the </span>*<span style="color: #000000">Templates </span>*<span style="color: #000000">parameter in the macro editor.</span>
> ⚠️ - <span style="color: #000000">Only templates listed in the configuration page for the respective diagram types are available to choose from in the macro editor.</span>
> ⚠️ - <span style="color: #000000">This parameter is not available in </span>*<span style="color: #000000">Graph from table</span>*<span style="color: #000000">, </span>*<span style="color: #000000">Space graph</span>*<span style="color: #000000"> and </span>*<span style="color: #000000">PlantUML</span>*<span style="color: #000000"> macros.</span> | <span style="color: #000000">template</span> |
| <span style="color: #000000">Output type</span> | <span style="color: #000000">png</span> | <span style="color: #000000">Specifies the output type to be generated by Graphviz. Since 2.1.0.</span><br>- <span style="color: #000000">*png*</span>
- <span style="color: #000000">*svg*</span>
- <span style="color: #000000">*pdf*</span>
- <span style="color: #000000">*jpg*</span>
- <span style="color: #000000">*gif*</span> | <span style="color: #000000">output</span> |
| <span style="color: #000000">Location of <type> source</span><br><span style="color: #000000">(Where 'type' includes </span>*<span style="color: #000000">Graphviz</span>*<span style="color: #000000">/ </span>*<span style="color: #000000">UML</span>*<span style="color: #000000">)</span> |  | <span style="color: #000000">Specifies the source from where the macro reads the data. </span><br>- *<span style="color: #000000">blank</span>*<span style="color: #000000"> - Data in the body is used.</span>
- *<span style="color: #000000">^attachment</span>*<span style="color: #000000"> - Data is read from an attachment to the current page. Input the value in the format ^</span>*<span style="color: #000000">Filename.extension.</span>*
- *<span style="color: #000000">page^attachment</span>*<span style="color: #000000"> - Data is read from an attachment to the page name provided.</span>
- *<span style="color: #000000">space:page^attachment</span>*<span style="color: #000000"> - Data is read from an attachment to the page name provided in the space indicated.</span>
- *<span style="color: #000000">#filename</span>*<span style="color: #000000">- Data is read from the file located in the Confluence home directory/script/filename. Subdirectories can be specified.</span>
- *<span style="color: #000000">global page template name</span>*<span style="color: #000000"> - Data is read from a global page template.</span>
- *<span style="color: #000000">space:page template name</span>*<span style="color: #000000"> - Data is read from a space template.</span><br>> ⚠️ <span style="color: #000000">Graphviz recognizes the commands only when you nest the commands under "noformat", "wiki-markup", "code", or "code-pro" macros, for the sources mentioned below:</span>
> ⚠️ 
> ⚠️ - <span style="color: #000000">*global page template name *</span>
> ⚠️ - *<span style="color: #000000">space:page template name</span>*<span style="color: #000000"> </span> | <span style="color: #000000">script</span> |
| <span style="color: #000000">Show </span><span style="color: #000000"><type></span><span style="color: #000000"> markup code</span><br><span style="color: #000000">(Where 'type' includes </span>*<span style="color: #000000">Graphviz</span>*<span style="color: #000000">/ </span>*<span style="color: #000000">UML</span>*<span style="color: #000000">)</span> | <span style="color: #000000">False</span> | <span style="color: #000000">Shows the markup code, Graphviz or UML, below the generated graph. Useful for fixing syntax errors or to see the markup that is generated by macro processing or macros like the </span>*<span style="color: #000000">Space graph</span>*<span style="color: #000000"> macro.</span> | <span style="color: #000000">showCode</span> |
| <span style="color: #000000">Attachment name</span> |  | <span style="color: #000000">Specify the name of the attachment to use, create or update. Use of attachments is optional but can be useful for linking from other places and to work with the </span>[<span style="color: #000000">Cache macro</span>](https://appfire.atlassian.net/wiki/spaces/CACHE/overview)<span style="color: #000000"> to improve display performance. </span><br><span style="color: #000000">Examples:</span><br>- <span style="color: #000000">graphviz.png — the image is saved as an attachment to the current page.</span>
- <span style="color: #000000">page^graphviz.png — the image is saved as an attachment to the page name provided.</span>
- <span style="color: #000000">Space:page^graphviz.png — the image is saved as an attachment to the page name provided in the space indicated.</span> | <span style="color: #000000">attachment</span> |
| <span style="color: #000000">Attachment version</span> | <span style="color: #000000">*new*</span> | <span style="color: #000000">Specifies how the generated graph is persisted as an attachment.</span><br>- *<span style="color: #000000">new</span>*<span style="color: #000000"> — creates a new version of the attachment.</span>
- *<span style="color: #000000">replace</span>*<span style="color: #000000"> — replaces all previous versions of the attachment. To replace an existing attachment, the user must be authorized to remove attachments for the page specified.</span>
- *<span style="color: #000000">keep</span>*<span style="color: #000000"> — only saves a new attachment if there is no existing attachment. An existing attachment will not be changed or updated.</span> | <span style="color: #000000">attachmentVersion</span> |
| <span style="color: #000000">Attachment comment</span> |  | <span style="color: #000000">Specify the comment on the attachment that is created or updated.</span> | <span style="color: #000000">attachmentComment</span> |
| <span style="color: #000000">Attachment versions to keep</span> |  | <span style="color: #000000">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. </span><span style="color: #000000">Since version 3.2. </span><br>> ⚠️ <span style="color: #000000">This parameter is only applicable if you select </span>*<span style="color: #000000">new</span>*<span style="color: #000000"> from the drop-down list under </span>*<span style="color: #000000">Attachment version</span>*<span style="color: #000000"> in the macro editor.</span> | <span style="color: #000000">attachmentLimit</span> |
| <span style="color: #000000">Thumbnail</span> | <span style="color: #000000">False</span> | <span style="color: #000000">Used when an attachment is specified, and output is PNG, JPG, or GIF. Renders graph as a thumbnail.</span><br>> ⚠️ - <span style="color: #000000">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.</span>
> ⚠️ - <span style="color: #000000">This parameter is not applicable for the </span>*<span style="color: #000000">Flowchart</span>*<span style="color: #000000"> and </span>*<span style="color: #000000">Space graph</span>*<span style="color: #000000"> macros.</span> | <span style="color: #000000">thumbnail</span> |
| <span style="color: #000000">Render wiki markup macros in body</span> | <span style="color: #000000">False</span> | <span style="color: #000000">Used to render wiki markup macros found in the body before processing as Graphviz markup. This is useful to run macros from </span>[<span style="color: #000000">Scripting for Confluence</span>](https://marketplace.atlassian.com/apps/266/scripting-for-confluence)<span style="color: #000000"> or similar that can produce Graphviz markup as output. Since 3.2.</span><br>> ⚠️ <span style="color: #000000">This parameter is not available in the </span>*<span style="color: #000000">Graph from table</span>*<span style="color: #000000"> and </span>*<span style="color: #000000">Space graph</span>*<span style="color: #000000"> macros.</span> | <span style="color: #000000">macros</span> |
| <span style="color: #000000">Layout</span> | <span style="color: #000000">dot</span> | <span style="color: #000000">Specifies which default layout algorithm to use. Since 3.2.</span><br>- <span style="color: #000000">*dot*</span><span style="color: #000000">− filter for drawing directed graphs</span>
- <span style="color: #000000">*neato*</span><span style="color: #000000"> − filter for drawing undirected graphs</span>
- <span style="color: #000000">* twopi *</span><span style="color: #000000">− filter for radial layouts of graphs</span>
- <span style="color: #000000">*circo*</span><span style="color: #000000">− filter for a circular layout of graphs</span>
- <span style="color: #000000">*fdp*</span><span style="color: #000000">− filter for drawing undirected graphs</span><br>> ⚠️ <span style="color: #000000">This parameter is not available in the </span>*<span style="color: #000000">PlantUML</span>*<span style="color: #000000"> macro.</span> | <span style="color: #000000">layout</span> |
| Profile |  | <span style="color: #000000">Specify a profile to be used with the macro. Administrators set up profiles to connect to other applications such as GitHub or GitLab. </span><span style="color: #000000">Profiles contain a basic set of parameters used to access a remote location such as the type of URL, user credentials, and so on. </span><span style="color: #000000">Some profiles may be restricted. Since 3.4.</span><br>> ⚠️ - <span style="color: #000000">This parameter is not available in the </span>*<span style="color: #000000">Graph from table</span>*<span style="color: #000000"> and </span>*<span style="color: #000000">Space graph</span>*<span style="color: #000000"> macros.</span>
> ⚠️ - <span style="color: #000000">Contact your administrator to know more about the profiles used in your instance.</span>
> ⚠️ - <span style="color: #000000">If a profile is specified, it is recommended to provide the relative path to the location of the required file to be rendered.</span> | profile |
| <span style="color: #000000">URL to <macro> file</span><br><span style="color: #000000">(Where 'macro' includes </span>*<span style="color: #000000">Graphviz/ Diagraph/ Graph/ PlantUML</span>*<span style="color: #000000">)</span> |  | <span style="color: #000000">Specifies the URL link to the Graphviz file. Administrators may restrict use. Since 3.2.</span><br>> ⚠️ - The URLs are restricted to the whitelisted URLs.
> ⚠️ - This parameter is not available in <span style="color: #003366">the</span> *Graph from table* and *Space graph* macros. | <span style="color: #000000">URL</span> |
| <span style="color: #000000">URL user</span>  
<span style="color: #ff0000">(Removed)</span> |  | <span style="color: #000000">Specify the user name to access the specified URL via basic authentication. Since 3.2.</span><br>> ❌ **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](https://bobswift.atlassian.net/wiki/spaces/info/pages/2537850172/Deprecation+notice%3A+URL+user+and+URL+user+password+parameters)). We recommend using [<span style="color: #000000">profiles</span>](https://appfire.atlassian.net/wiki/spaces/GVIZ/pages/70222033/Configure+for+data+center#profiles)<span style="color: #000000"> </span>to access external data. | <span style="color: #000000">user</span> |
| <span style="color: #000000">URL user password</span>  
<span style="color: #ff0000">(Removed)</span> |  | <span style="color: #000000">Specify the user password to access the specified URL via basic authentication. Since 3.2.</span><br>> ❌ **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](https://bobswift.atlassian.net/wiki/spaces/info/pages/2537850172/Deprecation+notice%3A+URL+user+and+URL+user+password+parameters)). We recommend using [<span style="color: #000000">profiles</span>](https://appfire.atlassian.net/wiki/spaces/GVIZ/pages/70222033/Configure+for+data+center#profiles)<span style="color: #000000"> </span>to access external data. | <span style="color: #000000">password</span> |
| <span style="color: #000000">URL connection timeout</span> |  | <span style="color: #000000">Specify the time in milliseconds used to increase the wait time to access the specified URL on slower connections. Since 3.2.</span> | <span style="color: #000000">timeout</span> |
| <span style="color: #000000">File encoding</span> |  | <span style="color: #000000">Specify the encoding of the file attachment if it is different from the Confluence default </span><span style="color: #000000">(like Windows-1252, UTF-8, MacRoman). Since 3.2.</span> | <span style="color: #000000">encoding</span> |
| <span style="color: #000000">Enable</span><span style="color: #000000"> </span><span style="color: #000000">scroll</span><span style="color: #000000"> </span><span style="color: #000000">bar</span> | <span style="color: #000000">true</span> | <span style="color: #000000">Used to enable scroll bar for the data generated by Graphviz. Since 3.4.1</span> | <span style="color: #000000">enableScroll</span> |
| <span style="color: #000000">Height</span><span style="color: #000000"> </span><span style="color: #000000">of</span><span style="color: #000000"> </span><span style="color: #000000">the</span><span style="color: #000000"> </span><span style="color: #000000">scroll</span><span style="color: #000000"> </span><span style="color: #000000">bar</span> | <span style="color: #000000">550px</span> | <span style="color: #000000">Specify the height of scroll (applicable when scroll bar is enabled). Since 3.4.1</span> | <span style="color: #000000">scrollHeight</span> |

> ⚠️ For multiple macro sources (i.e. template, attachment, and URL), the order of precedence is ***URL > attachment > template***.

> ℹ️ **Points to remember about profiles:**
> ℹ️ 
> ℹ️ - <span style="color: #000000">Only raw URLs must be given in either, the</span><span style="color: #000000"> </span>*<span style="color: #000000">URL</span>*<span style="color: #000000"> </span><span style="color: #000000">field in profiles or the</span><span style="color: #000000"> </span><span style="color: #000000">*URL to *</span>*<span style="color: #000000">Graphviz/Diagraph/Graph/PlantUML</span>*<span style="color: #000000">* file*</span><span style="color: #000000"> </span><span style="color: #000000">field, in the macros. </span><span style="color: #000000">A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. </span><span style="color: #000000">For example, in the URL string </span>[*<span style="color: #000000">http://www.contoso.com/articles/recent.aspx</span>*](http://www.contoso.com/articles/recent.aspx)<span style="color: #000000">, the raw URL is </span>*<span style="color: #000000">/articles/recent.aspx</span>*<span style="color: #000000">.</span>
> ℹ️ - <span style="color: #000000">It is recommended to specify absolute URLs to access files from public locations and to use profiles to access files from private sources. For example, a raw URL that can access a Graphviz file in a public Bitbucket repository is valid. But to render a file located in a private repository, we recommend using a profile.</span>
> ℹ️ - <span style="color: #000000">Profiles are a means to access and retrieve contents from external applications such as Bitbucket, GitLab or GitHub. </span><span style="color: #000000">A profile already contains the base URL and the required credentials (user credentials or an access token) to access the relevant application.</span>
> ℹ️ - <span style="color: #000000">This method allows multiple users to access a profile across pages and instances of the macro.</span>