Confluence Cloud

The integration with Confluence Cloud provides a quick and easy way to display Hava environment diagrams inside a Confluence page. It can be installed through our Atlassian Marketplace listing: Hava Viewer

Once a diagram is embedded, it can be viewed without consuming a Hava user licence or being logged into Hava.

Adding an environment to Confluence

To add an environment to your confluence page, you need to add and configure the Hava Viewer macro.

You can do this either by pressing the + button on the toolbar, or by typing / and then search for Hava

Search for Hava to find the Hava Viewer macro

This will add a blank view in your page editor like below.

You can modify the size of this using the context menu on the bottom (when selected)

To configure the macro, press the edit button to open up the configuration pane

Press the edit button in the context menu to configure the macro

The configuration page has a single input field where you put the embedded view key.

Add your key to the input box

Getting the key

There are several different embedded views in Hava, and they are all supported by the plugin. They can loosely be categorized into interactive and non-interactive views. For more details on our embedded views have a look at the embedded documentation.

Interactive Views

The interactive view give readers the ability to click on objects in the view and see more information about them.

To get a key for an Interactive View open the specific environment you would like to add to Confluence and press the share button on the top toolbar.

EMBED and EMBED LIGHT are Interactive Views, select the one you prefer, and copy the ID by pressing the COPY ID button.

Add the ID to the Embedded View Key input in the macro configuration and the macro should update with the embedded view.

Select your view type and copy the ID

Non-Interactive Views

The Non-Interactive View gives a static representation of the environment as a rasterized image. It does not allow users to interact with it, but it will load faster when opening the confluence page.

To get a key for a non Interactive View open the specific environment you would like to add to Confluence and press the share button on the top toolbar.

Select EMBED PNG in the modal and copy the full URL for the embedded PNG.

Add the URL to the Embedded View Key input in the macro configuration and the macro will update with the embedded view.

Select the URL and copy it to the clipboard

Once an interactive or static diagram is inserted into your confluence page, it will remain up to date. This includes the static PNG.

When Hava auto updates your network diagrams in response to configuration changes being detected, the diagrams at the end of your embedded diagram endpoints are also updated which means when you view diagrams within a confluence page, you are always looking at the latest version without the need to update anything in Confluence.

Self-Hosted

The Atlassian Confluence integration for Hava can be configured to work with a self-hosted version of Hava. This is achieved by configuring a different URL for the integration.

To configure the Hava Viewer application in Confluence, go to the main settings page and locate the Manage Application section on the left menu. Under Hava Viewer press the Configure button to bring up the Hava Viewer configuration page.

Confluence - Manage Applications

On the Hava Viewer configuration page enter the URL for your self-hosted instance of Hava. This needs to be a fully qualified DNS entry with either "http://" or "https://" at the start.

Once the URL has been entered, press Save to save the changes.

Hava Configuration Page