Lucidchart OnPrem for Confluence

Lucidchart OnPrem for Confluence is designed for strict behind-the-firewall requirements. It is a separate product from the Lucidchart Web App - it only works within Confluence Server and does not integrate with a Lucidchart account. When you use Lucidchart OnPrem for Confluence, no diagram data will ever leave your Confluence instance.

If your Confluence instance does not have this level of firewall restrictions and is able to connect to the Lucidchart Web App, you may want to consider using the Lucidchart Diagrams Connector instead of the OnPrem plug-in. See Confluence Integrations: for Team and Enterprise Admins to learn how to install the Connector to your instance.

You can install the Lucidchart OnPrem add-on automatically from the Atlassian Universal Plug-in Manager (UPM) or manually from the Atlassian marketplace.

To automatically install the add-on, follow these steps:
  1. Log in to your Confluence instance as an admin and open the Administration menu.
  2. Select "Add-ons."
  3. Select "Find new Add-ons" in the left panel. The Confluence UPM will open.
  4. Search the Atlassian marketplace for "Lucidchart OnPrem" and click "Install." Note: Please double check that you are installing the OnPrem Add-on, which will display a server rack diagram, rather that the Lucidchart Diagrams Connector.

    lucidchart_onprem_for_confluence_auto_install.png

To manually install the add-on from the Marketplace, follow these steps:
  1. Download the add-on frmo the Lucidchart OnPrem listing by selecting "Try It Free" or "Purchase Now."
  2. Log in to your Confluence instance as an admin and open the Administration menu.
  3. Select Add-ons > Manage Add-ons in the left panel.
  4. Click "Upload Add-on," then select the file you downloaded in step #1. The add-on will upload and install automatically.

    lucidchart_onprem_for_confluence_marketplace_app.png

Installation Issues

For those using MySQL, there is one common error that may occur if your MySQL packet size setting is too small. This is common for larger Atlassian apps and is easily fixed using Atlassian's documentation.

To add a Lucidchart diagram to a Confluence page, follow these steps:
  1. Begin editing a Confluence page.
  2. Click the "+" icon from the menu at the top of the page and select "Add Lucidchart (onprem) Diagram."

    lucidchart_onprem_add_a_diagram.png

    Alternatively, click anywhere on the page and type "{" then search "Lucidchart" and select "Lucidchart Onprem."

    lucidchart_onprem_macro_shortcut.png

  3. In the modal that appears, select to create a new Lucidchart document, insert an existing one, or import a Visio or Gliffy file.

    lucidchart_onprem_insert_a_diagram_modal.png

    If you choose to insert an existing diagram, you will have the option to create a copy of the original and edit that copy before inserting it.

    lucidchart_onprem_create_a_copy.png
  4. Click the "Save" button at the bottom of the Confluence page to publish it with the inserted diagram.

Lucidchart OnPrem editor is largely the same as our standard editor. This short tutorial explains the basic components of the editor and how to get started.

All features that are available in the Lucidchart Cloud Connector are available in OnPrem except for the following:

  • Seamless, real-time collaboration
  • @mention notifications
  • AWS infrastructure import
  • Org chart import
  • ERD import and export
  • UML sequence markup
  • Enhanced sharing and publishing
  • Linking diagrams to spreadsheet data

Lucidchart OnPrem supports the import of Visio files and stencils and the export of Visio diagrams.

Visio File Import

  1. Go to edit a Confluence page and select "+ Insert" then add "Add Lucidchart OnPrem diagram."
  2. In the left-side panel of the document picker, select "Import Visio/Gliffy File."

    Insert Viso Diagram in Lucidchart on Prem
  3. Upload the Visio file and then select "Import." It may take a few moments to import the Visio diagram, which will then open up in Lucidchart.

Visio File Export

  1. Open the diagram within the Lucidchart editor.
  2. Select File > Download As.
  3. Select the file type to download; options include Visio (VDX) format.

    Visio Export Lucidchart on Prem

Visio Stencil Import

  1. Open the diagram within the Lucidchart editor.
  2. Select "More Shapes" or press "M" to access your Shape Library Manager.

    More Shapes Lucidchart
  3. Click the blue "Visio Stencil" button in the top left to open the import dialog.

    Import Visio Stencil
  4. Choose the Visio stencil file and select upload to import the file.
  5. The Visio stencil will then upload into a custom library within the Shape Library Manager.

Note: Some Visio stencils contain EMF images that do not work within Lucidchart OnPrem. These can be imported with web-based Lucidchart and then you may copy and paste these into a custom shape library within Lucidchart OnPrem.

Every time you make a change to a Lucidchart diagram, a version is automatically saved in Confluence to prevent data loss. These are "minor" saves. By manually saving a diagram when you click "Return to Confluence," you will automatically create a "major" version of the diagram, and all previous minor changes will be erased to optimize performance.

If you would like to display (pin) or restore an older, major version of your Lucidchart diagram, rather than the most recently updated version, follow these steps:

  1. Start editing a Confluence page, select a Lucidchart diagram, and click Version in the pop-up panel.

    Revision History in confluence
  2. A dialog with a list of previous versions will appear.

    Versions List from Revision History
  3. Choose to display or restore an older version.

To Display: To display an older version on the Confluence page, just click on the version and select "Save." The Confluence page will then show this version even if someone makes new changes to it. You can, of course, go back to displaying the latest version any time.

To help avoid possible confusion from other collaborators, the viewer will display an icon on the left side of the bottom toolbar to indicate that it's set to display an older version.

To Display in Confluence

To Restore: To restore an older version, click the blue "Restore" button. Doing so makes it the latest version of the diagram, and all subsequent edits will be made to this new version.

If you see the following OAuth timestamp error when you try to install/configure the Lucidchart Confluence OnPrem plugin,

org.scribe.exceptions.OAuthException: Response body is incorrect. Can't extract token and secret from this: 'oauth_problem=expired_timestamp,_yours_1359614629,_ours_1359585813'

this likely means that the timestamp on your server hosting Confluence is not particularly accurate. Even if your server time seems okay, a discrepancy of 15-30 seconds can result in two servers not wanting to talk to each other. It's not possible to manually adjust server time with enough precision, so you'll need to synchronize your timestamp with an NTP server.


Related Articles
Confluence Integrations
Migrating Between the Lucidchart Editor and Confluence OnPrem
Gliffy to Lucidchart Conversion in Confluence
Confluence: Installing Lucidchart Through a Firewall or Proxy