Atlassian Confluence Integration

Visual Paradigm support integration with Atlassian Confluence in version 17.3 build 20250901. This allows you to directly publish your diagram images into Confluence. In this article we guide you through the steps to setup the integration and publish your diagrams.

  • Since this feature require version 17.3 build 20250901. If you using older build of v17.3 then please first perform software update to get this enhancement.

Create API Token

Visual Paradigm is relay on the API token to perform integration with Confluence. To create the API token:

  1. Login to your Confluence account.
  2. Press on your avatar at the top right and select Account Settings.

    Go to Account Settings in Confluence

    Go to Account Settings in Confluence

  3. Select Security.

    Select Security tab

    Select Security tab

  4. Go to API tokens and press Create and manage API tokens. Please note that you may prompt for perform verification in order to access to it.

    Go to Create and manage API token

    Go to Create and manage API token

  5. Press the Create API token.

    Press Create API token

    Press Create API token

  6. Specify the Name and the Expiry date of the token, and press Create button to create it.

    Specify name and expiry date of the token

    Specify name and expiry date of the token

  7. After the token being created, press Copy button to copy it to your system clipboard. It is recommend to keep it into a safe place in your computer so that you can reference to it later on.

    Copy API token to clipboard

    Copy API token to clipboard

Once the token is ready we can then switch back to Visual Paradigm desktop application.

Setup Integration

We can now go to setup the integration.

  1. In VP application, go to Windows > Application Options > General > Connection.

    Go to Application Options

    Go to Application Options

  2. Go to Atlassian Integration and enter the Domain of your Atlassian Confluence, your User email address, as well as your API token.

    Enter Altassian domain, user email and API token

    Enter Altassian domain, user email and API token

  3. Press Apply button to confirm the change, and press OK button to close the dialog.

You are now ready to publish your diagram to Confluence.

Publish your Diagrams

Everything is ready. Let’s publish our diagram to Confluence!

  1. Right click on the blank area of the diagram and select Export > Export to Confluence, or select Project > Export > Active Diagram to Confluence.

    Right click on diagram and export to Confluence

    Right click on diagram and export to Confluence

  2. Select the target space.
  3. Select <<New>> for publish your diagram as a new page, or choose an existing page to update with your diagram.

    Select space for publish the diagram

    Select space for publish the diagram

  4. Select Include diagram name and Include description for also output them to the page.
  5. Press OK to proceed.
  6. Once completed a message dialog will shows to let you know publish is done.

    Message dialog let you know the publish is done

    Message dialog let you know the publish is done

Now you can see the diagram being published to your specified space.

Diagram being published to Confluence

Diagram being published to Confluence

 

Related Know-how

Related Links

0 replies

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply