Lucidchart OnPrem for Confluence

NOTICE: Lucidchart will be ceasing support for Lucidchart OnPrem for Confluence on January 6, 2021. For more information, please contact Lucidchart at support+atlassian@lucidchart.com or refer to these FAQs.

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.
To edit an inserted diagram, follow these steps:
  1. When editing a page, select the diagram you want to edit.
  2. Select "edit" from the menu that appears. You will be directed to the Lucidchart editor.

    lucidchart_onprem_edit_a_diagram_.png
  3. Make your desired changes to the diagram, then click "back to Confluence" in the top left corner of the editor.
  4. Back on the Confluence page, click "Save" to publish your changes to the page.
  1. When editing a Confluence page, select the diagram you want to remove.
  2. Select "remove" from the menu that appears.

    lucidchart_onprem_remove_a_diagram.png
  3. In the modal that pops up, select "Remove Macro Only" to remove the diagram from only that page or "Delete Diagram" to remove the diagram file from the Existing Diagrams List, all Confluence pages, and all macros.

    lucidchart_onprem_delete_a_diagram_modal.png

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
  • Export CSV of shape data

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

To import a Gliffy or Visio file, follow these steps:

  1. Go to edit a Confluence page and select "+ Insert" then select "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.

To export a diagram as a Visio file, follow these steps:

  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.

    image__4_.png
  4. Follow the download flow, as detailed in the Export Your Documents article.

 

Lucidchart OnPrem supports the import of Visio stencils to a specific document through the shape manager. Please see the Import and Search for Shapes and Images Help Center section for instructions on how to import a stencil file to the Lucidchart editor.

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.
Why is Lucidchart sunsetting Lucidchart OnPrem?
Our goal is to provide you with the most complete, easy-to-use diagramming application on the market. We believe we can provide you with the best capabilities, constant innovation, and industry-leading security by shifting our focus entirely to our standalone Lucidchart cloud application.

What are the benefits of moving to the Lucidchart cloud application?

The Lucidchart cloud application provides many additional capabilities and benefits, including:
  • Industry-leading cloud security. See below for specific details.
  • Ability to access Lucidchart documents within Confluence, and through many other integrations such as GSuite, Jira, Microsoft Office, or Slack, directly within the Lucidchart cloud application.
  • Flexible licensing, where all users can view documents for free. You only pay for users that need to create or edit diagrams.
  • iOS and Android applications for creating and accessing your diagrams.
  • Enhanced real-time collaboration features, including co-authoring, chat, notifications, and publishing capabilities.
  • Automated diagram creation, including org charts, UML sequence diagrams, and ERDs.
  • Dynamic data capabilities, where you can combine data from external sources with your diagrams. For instance, you can overlay system performance data on an architectural diagram, or view employee skillsets visually on an org chart.
  • Conditional formatting and other advanced visualizations.
  • Automatic product updates every two weeks.

Our organization has concerns with using cloud products. Is the Lucidchart cloud solution secure?
Securing customer data is a primary objective at Lucidchart. Lucidchart complies with applicable local and international requirements and maintains compliance certifications, including PCI, Privacy Shield, and SOC 2. Lucidchart has obtained the SOC 2 Type I and SOC 2 Type II certifications. Check out our security page for more information.

Our data needs to stay in the EU. Can we still use Lucidchart?
Yes! Lucidchart has an AWS data center in Germany and offers local hosting in the EU for select customers. Please contact our team at support+atlassian@lucidchart.com for more information.

Which Confluence versions does Lucidchart OnPrem support?
Lucidchart OnPrem is currently supported on Confluence 7.2 and we will provide updates through Confluence 7.5. We will end support for Lucidchart OnPrem on January 6, 2021.

How do I get access to Lucidchart OnPrem versions after 7.2?
You can download the most recent version of Lucidchart OnPrem for Confluence from this Atlassian Marketplace page.

How can I continue to use Lucidchart going forward?

You can continue to use Lucidchart through either of the following two options:
  • First, you can continue to use Lucidchart OnPrem through Confluence 7.5. We will provide support through January 6, 2021.
  • Second, you can convert your existing Lucidchart OnPrem documents and account to our full, stand alone Lucidchart cloud application. If you are interested in using the advanced functionality and collaboration features of the full Lucidchart cloud application, including connecting to Confluence via the Confluence Connector, please contact us at support+atlassian@lucidchart.com.

We have hundreds or thousands of Lucidchart OnPrem documents in Confluence. How do we convert them to Lucidchart cloud application documents?

We have created an automated converter to convert your Lucidchart OnPrem documents to Lucidchart cloud documents, allowing you to easily convert documents within Confluence to our full Lucidchart cloud solution. You can learn more about the converter here.

If you choose not to move the documents to the Lucidchart cloud solution, the documents will continue to work through version 7.5 (or whichever version you update to before the end of your maintenance contract).

How can I learn more about the Lucidchart Confluence Connector?
You can learn more about the full Lucidchart cloud solution and the Confluence Connector here or by contacting us at support+atlassian@lucidchart.com.

We use Confluence Server or Data Center. Can we still use Lucidchart?
Yes! You can either continue using Lucidchart OnPrem through Confluence 7.5 until the sunset date, or you can convert your existing Lucidchart OnPrem documents and account to the full Lucidchart cloud solution. The full Lucidchart cloud solution can be connected to Confluence Server and Data Center, Jira Server and Data Center, as well as many other applications.

If we do nothing, what will happen to our Lucidchart OnPrem documents in Confluence?
If you choose not to move to the Lucidchart cloud application, your documents will continue to be available through Confluence 7.5 (so long as you update the Lucidchart OnPrem package).

Who do I contact with questions about the Lucidchart OnPrem sunsetting announcement?
For any questions about the Lucidchart OnPrem sunsetting, contact Lucidchart at support+atlassian@lucidchart.com.
What do I need to do to run the Lucidchart OnPrem to Lucidchart cloud converter?
See this section for a detailed, step-by-step process.

How can I know who has created Lucidchart OnPrem documents?
Install the latest version of Lucidchart OnPrem for Confluence. Navigate to "Manage Apps" in the Confluence admin portal, select "Lucidchart OnPrem for Confluence" and select “Configure.” Then select the “Usage Statistics” tab. On that page, you will be able to see which Confluence users have created documents and how many they have created.

Will users have permission to view & edit documents after the documents are converted to Lucidchart cloud?
Yes. Users will retain the ability to view and edit the documents that they had access to in Confluence. They will also have access to view and edit the documents directly in Lucidchart.

How long does it take to run the converter?
The time depends on a variety of factors (customer’s server processing speed, network connection, amount of data being converted), but we have seen it take up to 20 seconds per diagram.

Can I convert only some of my documents?
Yes and no. Conversion is performed space by space. However, the Lucidchart OnPrem and the Lucidchart Connector add-ons are incompatible with each other, so only one can be enabled at a time. If an admin would like to test the converter on one space before converting the entire instance, that is possible. However, Lucidchart OnPrem will need to be disabled temporarily while the Lucidchart Connector is enabled to show the converted macros working in the converted space.

Where are documents stored after they are converted to Lucidchart cloud?
Documents are uploaded to a new folder within the admin’s Lucidchart cloud account called “Converted from [Confluence Server URL]”.

Who will own the documents once converted? If it is not the person who originally created the document in Confluence, how can that person receive ownership?
The documents will be owned by the Lucidchart admin of the account. However, everyone who has edit access to the Confluence page where Lucidchart diagrams are shared, and who have Lucidchart accounts, will have edit access to those diagrams. If you would like to transfer ownership of a document, see here for a guide on how to do it.

Can I revert the conversion back to Lucidchart OnPrem after my space has been converted?
Yes. To do this, Lucidchart cloud documents must be reverted page by page (through the Confluence page revision history) back to Lucidchart OnPrem documents. We recommend that admins back up each space before running the conversion.
In order to use the Confluence Converter, the following must be true:
  • You have Lucidchart OnPrem installed on your Confluence Server Instance.
  • You have a paid or trial Lucidchart Cloud (lucidchart.com) account.
Please note before proceeding:
  • Documents are converted by space, not by page.
  • This cannot be undone in bulk without restoring a previous backup of the Confluence instance.
  • The conversion can be undone on a per-document basis by navigating to the document and restoring the page from the page history.
  • You can install the latest version of Lucidchart OnPrem before the conversion to get the number of users that have created documents. This information can be found in the Lucidchart OnPrem Configuration page under the “Usage Statistics” tab.
To use the converter, follow these steps:
  1. Create a backup of your Confluence Server instance.
  2. Uninstall Lucidchart OnPrem.
    1. Navigate to Confluence Administration > Manage Apps.
    2. Under “User-installed apps”, select “Lucidchart OnPrem for Confluence” to expand the Lucidchart OnPrem app dropdown.
    3. Select “Uninstall.”
  3. Install Lucidchart Server Connector from a file.
    1. Select “Upload App” in the top right corner.
    2. Select “Choose file” from the pop-up modal.
    3. Select the Server Connector OBR File.
    4. Select “Open.”
    5. Select “Upload.”
  4. Navigate to the converter page.
    1. In the “Lucidchart Plugin” dropdown, select “Configure.”
    2. Under the title “Lucidchart Plugin Configuration”, select the “Convert OnPrem” tab.
  5. Convert documents by space.
    1. Select “Search” to find all OnPrem documents in the Confluence instance.
    2. Identify the space that you would like to convert, and click “Convert.”


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